Files
werkbaum/docs/examples/werkbaum.werkbaum
T
mhoennigandClaude Fable 5 ea2c7eef4a feat: „Original wiederherstellen" im Dokumenten-Menü (D22-Nachtrag)
Auf der Prod-Instanz gab es keinen Weg, ein bearbeitetes mitgeliefertes
Dokument wieder auf den Auslieferungsstand zu bringen — der Reset ist ein
Debug-Knopf, und das Fingerabdruck-Nachziehen (D27) fasst bearbeitete
Texte nie an. Stilles Überschreiben beim Laden wäre überraschender
Datenverlust (verworfen); stattdessen ein Menü-Eintrag, sichtbar nur für
mitgelieferte Dokumente und nur bei Abweichung vom Auslieferungsstand,
mit Rückfrage. Stellt Text und Name wieder her, verwirft Falt-Eingriffe.
i18n in allen 9 Sprachen; im Browser durchgespielt (erscheint nach Edit,
stellt her, verschwindet wieder).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-22 20:04:10 +02:00

183 lines
9.5 KiB
Plaintext

%% 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)
- [^] Optional nodes — neither required nor an alternative (S)
- [^] Node IDs (#auth) (S) %% often just the ticket number, see SPEC §11
+ [?] Free tags, &tag (M) %% only together with a consumer, see D34
- [?] A lens: highlight every node tagged &x (S)
- [^] Dependencies across the tree, (:#auth,#api) (M)
- [^] They constrain the status, not when work may start (S)
- [^] Effective status: intrinsic, plus what it depends on (S)
- [^] Cycles are legal — they mean "finished together" (XS)
- [^] An id with no node behind it is a warning (XS)
- [^] XOR, = — exactly one alternative, not at least one (S)
- [^] Node descriptions, shown as a tooltip (M)
- [^] A short text right at the node (S) %% a " line below the node
- [^] A long block at the end, addressed by its id (S) %% behind a --- separator
- [-] 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)
- [^] Cross links for dependencies (M)
- [^] Visually secondary — the tree carries the message (S)
- [^] Highlight what a selected node needs and feeds (S)
- [^] Cheapest path (M)
- [^] Cost model, missing size counts as M (S)
- [^] Metro-map line through the leaves (S)
- [^] Count the whole dependency closure #closure (M)
- [^] Shared dependencies counted only once (S)
- [^] The cheapest alternative is no longer the local one (M) %% see D34, D42
| [^] Search exactly, the trees are small enough (M)
- [^] Enumerate the coupled any-of choices (S)
- [^] Cost is the size of the union (S)
| [^] Stay greedy, but say so (XS) %% built as the named fallback
- [^] 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)
- [^] Several documents in one editor (M)
- [^] Switcher in the editor title bar (S)
- [^] Load a document from ?sourceUrl= (S)
- [x] Restore a shipped document from the menu (XS)
- [^] Jump between diagram and text (S)
- [^] Line numbers in the text editor (XS) %% the warnings name them
- [^] Collapsible subtrees (M)
- [^] Initial state from the text: > collapses, < re-opens (S)
- [^] Fold and unfold in the diagram, independently of the text (S)
- [ ] Open and save .werkbaum files (S)
+ [^] Show what is new since your last visit (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 #scaffold (M)
- [ ] Gradle Kotlin DSL, JDK 21 (S)
- [ ] Health endpoint and CI (S)
- [ ] Documents on the server #docs (L) :#scaffold
- [ ] Text plus metadata, no structure format (M)
- [ ] REST endpoints (S)
- [ ] Persistence (S)
- [ ] Share by link (S)
- [?] Accounts and permissions (L) :#docs
| [?] Single user, one token (S)
| [?] Log in with OIDC (L)
- [~] Collaborating on a Diagram (XL)
" The pad merges concurrent edits, Werkbaum renders the plan.
- [^] Watch a shared Etherpad — it merges, we render (S)
- [^] Load the pad's plain-text export (XS)
- [^] Reload on demand (XS) %% a timer only trips Etherpad's rate limit
- [^] Embed the pad, keep the text mirror beside it (M)
- [^] Three views: pad and text, pad only, text only (S)
- [^] Splitter between pad and mirror (XS)
- [?] Editing in the frame stops after a while (S) %% SameSite=Lax, see D31
| [?] Ask the admin for cookie.sameSite = None (XS)
| [ ] Live with it: edit in the pad's own tab (XS)
- [^] A shared pointer: !!! focuses a node for everyone (XS)
- > [?] Update by itself, within about 2 s (M)
| [?] Our own Etherpad beside Werkbaum (M) %% then every setting below is ours
- [ ] Node and a real database in userland (S) %% the flatfile store is not for production
- [ ] Book the RAM quota for an own daemon (XS)
- [ ] Reverse proxy in .htaccess, websockets included (S) %% Mattermost does it, wiki shows how
- [ ] systemd user unit so it survives a reboot (XS)
- [!] Keeping a public service patched (S) %% indefinitely, that is the real cost
| [?] Admin raises the export rate limit (XS) %% default is 10 per 90 s
| [?] Admin installs a plugin that pushes the text (S) %% postMessage to the page
| [?] Our own backend holds one socket and fans out (XXL) :#scaffold
| [ ] Poll inside the budget, at best every 9 s (S) %% legal, but not 2 s
| [-] Our own socket straight to the pad (L) %% measured: upgrade refused
| [-] Read the pad's HTML instead of the export (M) %% measured: no CORS header
- [ ] Git as the shared store (L)
| [ ] A file in a repository, changed by pull request (S) %% works today, no code
| [?] The backend commits every change (L) :#scaffold
- [?] History and restore (M)
- [?] Diff between two versions (S)
- [?] Who changed this line (S)
- [?] A branch per scenario (S)
- [?] Live editing, several people at once (XL)
- [ ] Transport over a websocket (S) :#scaffold %% the easy half
- [!] Merging simultaneous edits (L) %% the actual work
| [?] Text CRDT — the plan is plain text, so it fits (L)
| [?] Operational transformation (XL)
- [?] Cursors and who else is here (S)
- [-] A merge algorithm of our own (XL) %% solved problem, do not reinvent
- [?] 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)
- > [?] IntelliJ IDEA plugin (XL)
- [?] Show the diagram in the IDE (L)
| [?] Through Mermaid, once Werkbaum is part of Mermaid itself (M)
- [?] Fenced werkbaum blocks render in Markdown (S)
- [-] A self-hosted Mermaid diagram type (S) %% the IDE brings its own Mermaid
| [?] Our own preview: the bundled single file in a JCEF window (M)
- [?] Hand the editor text in (S)
- [?] Get the clicked line back to the caret (S)
+ [?] A real editor, not just a preview (XL)
- [?] Language support for .werkbaum (L)
- [?] Lexer and parser to a PSI tree (M)
- [?] Syntax highlighting (S)
- [?] Warnings as inspections (S) %% mixed gate, unknown status
- [?] Completion for status, size and tags (S)
- [?] Structure view and folding (S)
- [?] Kotlin with the Gradle IntelliJ plugin (S)
- < [!] A second parser that must not drift from the SPEC (M) %% exactly what D14 warns about
| [?] Both parsers test against the same fixtures (S)
| [?] Run the one JS parser inside the IDE (M)
- [?] Tracker integration (XL) %% exactly one of these, hence =
= [?] Taiga (L) https://taiga.io
- [ ] Resolve "#123" over the REST API #resolve (M)
- [ ] Read title, link and status (S)
- [ ] Map the workflow onto the states (S)
- [?] Write the status back (M) :#resolve
- [-] 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)
---
#closure
The cheapest path pulls every dependency of a needed node into the
needed set, and shared targets count only once. That is why an
alternative can win although it looks more expensive locally: its
dependencies are already paid for elsewhere (see D34 and D42).
#scaffold
Spring Initializr project with Gradle Kotlin DSL on JDK 21.
Everything server-side hangs off this one node — that is what the
:#scaffold dependencies across the tree point at.