docs: Eigene Endung .werkbaum + fünf Beispieldateien unter docs/examples/
Mit nur einem Beispiel ließ sich das Umschalten zwischen Dokumenten (D22) nicht zeigen — jeder ?sourceUrl=-Link legt genau ein Dokument an (D23), erst mehrere nacheinander geöffnete füllen den Wähler. - Neue Endung `.werkbaum` (D24, SPEC §12): macht Notationstexte zuordenbar (spätere Editor-Zuordnung, Syntax-Highlighting, Öffnen/Speichern). Konvention, kein Vertrag — `?sourceUrl=` wertet weder Endung noch Content-Type aus, `.txt` bleibt gültig. `.gitattributes` führt `*.werkbaum` als Text (LF). - docs/example-plan.txt -> docs/examples/example-plan-0.werkbaum (Inhalt bis auf die Kopfzeile unverändert); README-Links nachgezogen. - Neu, je einen anderen Aspekt zeigend: example-plan-1 (Küche: kein Software-Plan, alternativenlastig — günstigster Pfad), example-plan-2 (Konferenz: breiter Fächer, viele Beteiligte), example-plan-3 (drei Wurzeln = drei Bäume nebeneinander, dazu ein Knoten ohne Größe für das implizite-M-Badge), example-werkbaum (Werkbaum selbst: Bestand + mögliche Weiterentwicklung, destilliert aus ROADMAP/TASKS/DECISIONS). - README.md / README.de.md: Tabelle mit den fünf Live-Links samt Hinweis, dass sie nacheinander geöffnet den Dokument-Wähler füllen. Verifiziert: alle fünf parsen headless ohne Warnungen und ohne gemischte Gates (19/26/43/28/79 Knoten, 3 Wurzeln in Beispiel 3); Vitest 34/34 grün. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
mhoennig
co-authored by
Claude Opus 4.8
Claude Opus 4.8
parent
4d0fb9edd7
commit
cdf843e2e3
@@ -0,0 +1,22 @@
|
||||
%% Werkbaum example 0 — a software project, all eight states in one tree.
|
||||
%% Full notation reference: docs/SPEC.md
|
||||
|
||||
[~] Online shop relaunch (XL) https://example.com/shop
|
||||
- [x] Discovery (M)
|
||||
- [x] User interviews (S) @maria
|
||||
- [x] Competitor scan (XS)
|
||||
- [~] Checkout (XL)
|
||||
- [/] Shopping cart (M) @tom
|
||||
- [x] Add and remove items (S)
|
||||
- [/] Discount codes (S)
|
||||
- [!] Payment provider (L) @maria @tom %% effort still unclear
|
||||
| [ ] Stripe (M)
|
||||
- [ ] Sandbox account (XS)
|
||||
- [ ] Webhook handling (S)
|
||||
| [?] PayPal (M)
|
||||
| [-] Build our own PSP (XXL) %% far too expensive
|
||||
- [ ] Order confirmation mail (S)
|
||||
- [?] Hosting (M)
|
||||
| Managed cloud (S) https://hostsharing.net
|
||||
| On-premise (L)
|
||||
- [^] Landing page (S) @lena
|
||||
@@ -0,0 +1,29 @@
|
||||
%% Werkbaum example 1 — a plan that is not software at all.
|
||||
%% Lots of alternatives: switch the cheapest-path button on and off.
|
||||
|
||||
[~] New kitchen (XL)
|
||||
- [x] Budget and measurements (S) @sam
|
||||
- [~] Layout (M)
|
||||
- [x] Floor plan sketch (XS)
|
||||
- [~] Where the appliances go (S) @kim
|
||||
- [ ] Worktop (M)
|
||||
| [ ] Laminate (S)
|
||||
| [?] Solid oak (L)
|
||||
| [?] Quartz composite (L)
|
||||
| [-] Marble (XL) %% too soft for a kitchen, and way over budget
|
||||
- [ ] Floor (M)
|
||||
| [ ] Vinyl planks (S)
|
||||
| [?] Tiles (M)
|
||||
- [ ] Take out the old screed (S)
|
||||
- [ ] Check the underfloor heating (XS)
|
||||
- [!] Move the water connection (M) @kim %% no idea what that wall hides
|
||||
- [ ] Electrics (L)
|
||||
- [ ] Own circuit for the oven (M)
|
||||
- [ ] Cable route (S)
|
||||
- [ ] Free slot in the fuse box (XS)
|
||||
- [ ] Sockets on the island (S)
|
||||
- [?] Splashback (S)
|
||||
- [ ] Assembly weekend (M) @sam @kim @dad
|
||||
- [ ] Carcasses (S)
|
||||
- [ ] Doors and drawers (S)
|
||||
- [ ] Silicone joints (XS)
|
||||
@@ -0,0 +1,46 @@
|
||||
%% Werkbaum example 2 — an event: wide plan, many people, few alternatives.
|
||||
%% Good for the horizontal mode; try the compact one for comparison.
|
||||
|
||||
[~] Community conference 2027 (XXL) https://example.org/conf
|
||||
- [^] Save the date announced (XS) @lena
|
||||
- [x] Venue (L)
|
||||
- [x] Shortlist three halls (S) @lena
|
||||
- [x] Site visit (S) @lena @tom
|
||||
- [x] Contract signed (M)
|
||||
- [x] Cancellation clause (S)
|
||||
- [x] Deposit paid (XS)
|
||||
- [~] Programme (XL) @maria
|
||||
- [x] Call for papers (S) https://example.org/conf/cfp
|
||||
- [~] Review (M) @maria @tom
|
||||
- [x] Reviewer team (S)
|
||||
- [~] Second round (S)
|
||||
- [ ] Schedule (M)
|
||||
- [ ] Tracks and rooms (S)
|
||||
- [ ] Breaks that actually work (XS)
|
||||
- [ ] Keynote (M)
|
||||
| [ ] Ask the local research group (S)
|
||||
| [?] Invite an international speaker (L) %% travel budget?
|
||||
- [~] Sponsors (L) @ben
|
||||
- [x] Package prices (S)
|
||||
- [~] Approach last year's sponsors (M)
|
||||
- [x] Mailing (XS)
|
||||
- [~] Follow-up calls (S) @ben
|
||||
- [ ] Logos on the website (XS)
|
||||
- [ ] Catering (M)
|
||||
| [ ] Buffet from the hall's caterer %% nobody has priced these two yet
|
||||
| [?] Food trucks in the yard
|
||||
| [-] Everyone brings something (S) %% not with 300 guests
|
||||
- [ ] Website (M) @sam
|
||||
- [x] Landing page (S)
|
||||
- [ ] Ticket shop (M)
|
||||
- [ ] Payment provider (S)
|
||||
- [ ] Refunds and name changes (S)
|
||||
- [ ] Schedule page (S)
|
||||
- [!] Recording and streaming (L) @tom %% hall has no fixed technology
|
||||
- [ ] On the day (L)
|
||||
- [ ] Helper shifts (M)
|
||||
- [ ] Registration desk (S)
|
||||
- [ ] Room angels (S)
|
||||
- [ ] Signage (S)
|
||||
- [ ] Badges printed (XS) @lena
|
||||
- [?] Social event in the evening (S)
|
||||
@@ -0,0 +1,34 @@
|
||||
%% Werkbaum example 3 — three trees side by side.
|
||||
%% A line without a leading "-" or "|" starts a new root (SPEC §2), so one
|
||||
%% document can hold several independent plans.
|
||||
|
||||
[~] Now: ship the mobile app (L)
|
||||
- [x] Beta with 50 testers (S) @kim
|
||||
- [~] Fix what the beta found (M)
|
||||
- [x] Crash on rotate (S)
|
||||
- [~] Slow start-up (S)
|
||||
- [ ] Store listing (M)
|
||||
- [ ] Screenshots (S)
|
||||
- [ ] Privacy declaration (S)
|
||||
- [!] App review, first submission (S) %% nobody knows how long this takes
|
||||
|
||||
[ ] Next: a second office (L)
|
||||
- [ ] Pick the city (M)
|
||||
| [ ] Leipzig (M)
|
||||
| [?] Porto (L)
|
||||
| [-] Zurich (XL) %% rents eat the whole budget
|
||||
- [ ] Find rooms (M)
|
||||
- [ ] Broker briefing (XS)
|
||||
- [ ] Three viewings (S)
|
||||
- [ ] Hire the first two people (L)
|
||||
- [ ] Job ads (S)
|
||||
- [ ] Interviews on site (M)
|
||||
- [ ] Travel budget (XS)
|
||||
- [ ] Interview guide (S)
|
||||
|
||||
[?] Someday: our own hardware (XXL)
|
||||
| [?] Buy a white-label device and brand it (L)
|
||||
| [?] Build it ourselves (XXL)
|
||||
- [?] Board design %% no size yet — the cheapest path assumes M
|
||||
- [?] Certification (L)
|
||||
| [-] Licence the design to someone else (M) %% then it is not our product
|
||||
@@ -0,0 +1,82 @@
|
||||
%% Werkbaum, planned with Werkbaum — what exists today and where it could go.
|
||||
%% Distilled from docs/ROADMAP.md, docs/TASKS.md and docs/DECISIONS.md.
|
||||
|
||||
[~] Werkbaum (XXL) https://github.com/mhoennig/werkbaum
|
||||
- [^] Notation (L)
|
||||
- [^] Line format (M)
|
||||
- [^] Status box, eight states (S)
|
||||
- [^] T-shirt size and the "decompose from M" rule (S)
|
||||
- [^] People tags, bare URLs, %% comments (XS)
|
||||
- [^] And/or decomposition (S)
|
||||
- [-] A separate storage format for the structure (L) %% the text is the format
|
||||
- [ ] Ticket references #123 (S)
|
||||
- [?] Benefit per node, not only cost (M)
|
||||
| [?] Another sigil next to the size (S)
|
||||
| [?] Story points behind the T-shirt sizes (M)
|
||||
- [~] Editor (XL) https://werkbaum.javagil.de
|
||||
- [^] Live diagram from text (M)
|
||||
- [^] Parser (S)
|
||||
- [^] Renderer, three layout modes (M)
|
||||
- [^] Horizontal fan (S)
|
||||
- [^] Vertical, transposed (S)
|
||||
- [^] Compact (S)
|
||||
- [^] Cheapest path (M)
|
||||
- [^] Cost model, missing size counts as M (S)
|
||||
- [^] Metro-map line through the leaves (S)
|
||||
- [^] Export (M)
|
||||
- [^] SVG and PNG download (S)
|
||||
- [^] PNG to the clipboard (S)
|
||||
- [^] Print stylesheet (XS)
|
||||
- [^] Nine interface languages (M)
|
||||
- [^] Translations (S)
|
||||
- [^] Default taken from the browser (XS)
|
||||
- [^] Accessibility: aria labels, focus order (S)
|
||||
- [^] Works on a phone (S)
|
||||
- [x] Several documents in one editor (M)
|
||||
- [x] Switcher in the editor title bar (S)
|
||||
- [x] Load a document from ?sourceUrl= (S)
|
||||
- [ ] Open and save .werkbaum files (S)
|
||||
- [?] A pastel colour per person (S)
|
||||
- [?] Dates and milestones (M)
|
||||
| [?] An attribute in the line (S)
|
||||
| [?] A separate timeline view (L)
|
||||
- [^] Build and delivery (M)
|
||||
- [^] One self-contained file, bundled by Vite (S)
|
||||
- [^] Unit tests (S)
|
||||
- [^] Published on every push (S)
|
||||
- [-] Deploy through a gh-pages branch (S) %% GitHub Actions instead
|
||||
- [-] Fonts from Google (XS) %% self-hosted, no third-party request
|
||||
- [ ] Backend (XL)
|
||||
- [ ] Kotlin and Spring Boot scaffold (M)
|
||||
- [ ] Gradle Kotlin DSL, JDK 21 (S)
|
||||
- [ ] Health endpoint and CI (S)
|
||||
- [ ] Documents on the server (L)
|
||||
- [ ] Text plus metadata, no structure format (M)
|
||||
- [ ] REST endpoints (S)
|
||||
- [ ] Persistence (S)
|
||||
- [ ] Share by link (S)
|
||||
- [?] Accounts and permissions (L)
|
||||
| [?] Single user, one token (S)
|
||||
| [?] Log in with OIDC (L)
|
||||
- [?] Mermaid plugin (XL)
|
||||
- [!] A layout engine of its own (XL) %% measure, place, route — the real work
|
||||
- [ ] Measure node sizes (M)
|
||||
- [ ] Text metrics without a browser (S)
|
||||
- [ ] Badges and tags inside the box (S)
|
||||
- [ ] Place nodes and route connectors (L)
|
||||
- [ ] All-of fan (M)
|
||||
- [ ] Horizontal (S)
|
||||
- [ ] Transposed (S)
|
||||
- [ ] Any-of rail (S)
|
||||
- [?] Registration with Mermaid (M)
|
||||
| [?] External diagram, self-hosted pages only (M)
|
||||
| [?] Pull request into Mermaid itself (L)
|
||||
- [?] Tracker integration (XL)
|
||||
| [?] Taiga (L) https://taiga.io
|
||||
- [ ] Resolve #123 over the REST API (M)
|
||||
- [ ] Read title, link and status (S)
|
||||
- [ ] Map the workflow onto the states (S)
|
||||
- [?] Write the status back (M)
|
||||
- [-] A plugin inside Taiga itself (L) %% legacy frontend, self-hosted only
|
||||
| [?] Tenzu, the successor (XXL) https://tenzu.net
|
||||
| [ ] No tracker, plain text is enough (XS)
|
||||
Reference in New Issue
Block a user