From 37017c1175872f5b6d8379bf7f21202a20cb65b3 Mon Sep 17 00:00:00 2001 From: Julien Calixte Date: Sat, 20 Jun 2026 09:37:50 +0200 Subject: [PATCH] docs: align design docs and README with the editor --- CONTEXT.md | 4 +- DESIGN.md | 191 ++++++++++-------- README.md | 2 +- docs/adr/0001-detected-feedback-loops.md | 2 +- .../0003-flow-as-node-materialised-clouds.md | 4 +- 5 files changed, 113 insertions(+), 90 deletions(-) diff --git a/CONTEXT.md b/CONTEXT.md index cdd9716..620c615 100644 --- a/CONTEXT.md +++ b/CONTEXT.md @@ -2,7 +2,7 @@ The ubiquitous language for **meadows** — a web app for building systems-thinking models (stock-and-flow diagrams with feedback loops) in the spirit of Donella -Meadows' *Thinking in Systems*. The diagram is the product now; numeric simulation +Meadows' _Thinking in Systems_. The diagram is the product now; numeric simulation is a planned later phase, so the language is chosen to be simulation-ready. Part of [meadows](./README.md); see [DESIGN.md](./DESIGN.md) for how these terms @@ -12,7 +12,7 @@ map to goals, functions, and components. **System**: The real-world thing being studied — an interconnected set of elements producing -a behaviour over time. It is the *referent*, never the artifact in the app. +a behaviour over time. It is the _referent_, never the artifact in the app. _Avoid_: model, diagram, map (those are the artifact, not the real thing). **Model**: diff --git a/DESIGN.md b/DESIGN.md index b6e9796..dd6accc 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -256,10 +256,10 @@ symbols: ● strong (9) · ◐ medium (3) · △ weak (1). Roof: `++`/`+` reinfo } \begin{document} -% --- meadows: 3 goals (WHATs) x 9 functions (HOWs); no competitor zone; +% --- meadows: 4 goals (WHATs) x 10 functions (HOWs); no competitor zone; % basement = Target / Importance Sigma / Relative %. --- -\def\qfdNW{3} -\def\qfdNH{9} +\def\qfdNW{4} +\def\qfdNH{10} \def\qfdWhatW{4.2} \def\qfdBasementN{3} \def\qfdWhatsTitle{Goals (WHATs)} @@ -270,23 +270,26 @@ symbols: ● strong (9) · ◐ medium (3) · △ weak (1). Roof: `++`/`+` reinfo \pgfmathsetmacro{\qfdWhatTextW}{\qfdWhatW - 0.2} \foreach \r/\t in {1/{G1 Build with near-zero friction}, 2/{G2 Feedback surfaces as live insight}, - 3/{G3 Models safe \& portable}} + 3/{G3 Models safe \& portable}, + 4/{G4 Learn the language by example}} \node[anchor=west, font=\scriptsize, text width=\qfdWhatTextW cm, align=left] at ({\qfdLeftEdge + 0.1}, {-\r + 0.5}) {\t}; - \foreach \r/\imp in {1/9, 2/8, 3/7} + \foreach \r/\imp in {1/9, 2/8, 3/7, 4/4} \node[font=\scriptsize] at ({-\qfdImpW/2}, {-\r + 0.5}) {\imp}; % --- HOWs (functions, rotated) --- \foreach \c/\t in {1/{F1 place node}, 2/{F2 connect}, 3/{F3 smooth canvas}, 4/{F4 valid inline}, 5/{F5 loops live}, 6/{F6 polarity}, - 7/{F7 autosave}, 8/{F8 round-trip}, 9/{F9 undo/redo}} + 7/{F7 autosave}, 8/{F8 round-trip}, 9/{F9 undo/redo}, + 10/{F10 samples}} \node[rotate=90, anchor=west, font=\scriptsize] at ({\c - 0.5}, 0.15) {\t}; % --- Relation matrix (col c = function, row r = goal); strength S/M/W --- - \foreach \c/\r/\s in {1/1/S, 2/1/S, 3/1/S, 4/1/M, 5/1/W, 6/1/M, 7/1/W, 9/1/M, + \foreach \c/\r/\s in {1/1/S, 2/1/S, 3/1/S, 4/1/M, 5/1/W, 6/1/M, 7/1/W, 9/1/M, 10/1/W, 2/2/M, 3/2/W, 4/2/M, 5/2/S, 6/2/S, 9/2/W, - 4/3/W, 7/3/S, 8/3/S, 9/3/S} + 4/3/W, 7/3/S, 8/3/S, 9/3/S, + 5/4/M, 6/4/W, 10/4/S} \node[qfdrel/\s] at ({\c - 0.5}, {-\r + 0.5}) {}; % --- Roof correlations (C-i-j, i