mhoennigandClaude Opus 4.8
7911cb10c5
Deutsch bleibt Quellsprache (CLAUDE: "Doku auf Deutsch"), daher die Uebersetzung als separate README.en.md statt README.md zu ersetzen. Wechselseitige Sprachlinks oben in beiden Dateien; Hinweis in der englischen Fassung, dass sie eine Convenience-Uebersetzung ist und der deutschen Vorlage hinterherhaengen kann. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
68 lines
2.4 KiB
Markdown
68 lines
2.4 KiB
Markdown
<p>
|
|
<img src="docs/brand/logo.svg" width="72" alt="Werkbaum-Logo">
|
|
</p>
|
|
|
|
# Werkbaum
|
|
|
|
**Deutsch** · [English](README.en.md)
|
|
|
|
Eine textuelle, Markdown-artige Notation für Projektstrukturpläne
|
|
(Work Breakdown Structure) mit Und/Oder-Zerlegung — und ein Live-Editor,
|
|
der sie als Diagramm rendert.
|
|
|
|
```
|
|
[~] Werkbaum (XL) https://wiki.example.de/relaunch
|
|
- [~] Dokumentenspeicher
|
|
| [x] Textdatei mit Copy+Paste im Frontend (S)
|
|
- [x] Parser
|
|
- [x] Texteingabefeld im Frontend
|
|
| [ ] Backend
|
|
- [~] Darstellung/Rendern (XL)
|
|
- [/] H (S) @anna
|
|
- [ ] CMS-Anbindung (M)
|
|
| [ ] WordPress
|
|
| [?] Headless CMS
|
|
```
|
|
|
|
`-` = Pflicht-Teilpaket (all of, im Diagramm nebeneinander) ·
|
|
`|` = Alternative (any of, untereinander) · `[…]` = Status ·
|
|
`(M)` = T-Shirt-Aufwand · `@name` = Zuständigkeit · `%%` = Kommentar.
|
|
|
|
## Nutzung
|
|
|
|
`frontend/index.html` im Browser öffnen — links Text bearbeiten, rechts entsteht das
|
|
Diagramm live. Toggles: transponierte (schmale) Darstellung, verworfene
|
|
Elemente einblenden.
|
|
|
|
## Projektdokumente
|
|
|
|
- `frontend/` — Editor · `backend/` — Kotlin/Spring (Gerüst folgt, siehe backend/README.md)
|
|
- `docs/SPEC.md` — verbindliche Sprachdefinition
|
|
- `docs/DECISIONS.md` — Design-Entscheidungen mit Begründung
|
|
- `docs/ROADMAP.md` — Mermaid-Plugin, Taiga-Integration, Tenzu
|
|
- `docs/TASKS.md` — offene Aufgaben (Checkboxen)
|
|
- `docs/brand/BRAND.md` — Logo, Wortbild, Anwendungsregeln
|
|
- `docs/design/` — Design-Herleitung der Marke
|
|
- `CLAUDE.md` — Projektkontext für Claude Code
|
|
|
|
## Deployment
|
|
|
|
Der Editor wird per GitHub Actions als statische Seite auf **GitHub Pages**
|
|
veröffentlicht (Workflow: `.github/workflows/pages.yml`). Ausgelöst bei jedem
|
|
Push auf `main` sowie manuell (`workflow_dispatch`).
|
|
|
|
Der Workflow stellt einen Site-Ordner zusammen: `frontend/index.html` liegt als
|
|
`index.html` an der Wurzel-URL, dazu die vom Editor referenzierten Dateien
|
|
(`docs/brand/` fürs Favicon, `LICENSE` für den MIT-Link im Footer). Die
|
|
`../`-Pfade der Editor-Quelle werden dabei nur auf der Kopie geradegezogen — die
|
|
Quelldatei bleibt unverändert. `backend/` und die übrigen `docs/` werden nicht
|
|
veröffentlicht.
|
|
|
|
**Einmalige Einrichtung:** In den Repo-Settings unter **Pages** als **Source**
|
|
„GitHub Actions" wählen. Das Repo muss dafür **öffentlich** sein (GitHub Pages
|
|
via Actions ist für private Repos nur mit kostenpflichtigem Plan verfügbar).
|
|
|
|
## Lizenz
|
|
|
|
MIT — siehe [LICENSE](LICENSE). © 2026 Michael Hönnig.
|