mhoennigandClaude Opus 4.8
63cfd82f07
- prominent oben und in Nutzung/Usage: https://mhoennig.github.io/werkbaum/ - in EN (README.md) und DE (README.de.md) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
83 lines
3.4 KiB
Markdown
83 lines
3.4 KiB
Markdown
<p>
|
|
<img src="docs/brand/logo.svg" width="72" alt="Werkbaum-Logo">
|
|
</p>
|
|
|
|
# Werkbaum
|
|
|
|
[English](README.md) · **Deutsch**
|
|
|
|
**▶ Live ausprobieren: <https://mhoennig.github.io/werkbaum/>** (jeweils neueste veröffentlichte Version)
|
|
|
|
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
|
|
|
|
|
|
|
|
Den [gehosteten Editor](https://mhoennig.github.io/werkbaum/) öffnen — oder
|
|
`frontend/index.html` im Browser — 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.
|
|
|
|
Beim Zusammenstellen setzt der Workflow zudem die Versionsnummer im Footer:
|
|
**Major.Minor** stammt aus der Datei `VERSION` (per bewusstem „Bump-Commit"
|
|
gepflegt), die **Micro-Stelle** aus der Zahl der Commits seit diesem letzten
|
|
Bump — sie steigt also mit jedem Commit und beginnt nach einem Bump wieder bei
|
|
`0` (`Werkbaum 1.0.0`, `1.0.1`, … dann `VERSION` auf `1.1` bumpen → `1.1.0`). Es
|
|
wird nichts ins Repo zurückgeschrieben. Im Footer verlinkt der Name **Werkbaum**
|
|
die Repo-Startseite, die **Versionsnummer** genau den zugehörigen Commit
|
|
(`…/commit/<sha>`). Lokal geöffnet zeigt der Editor den Platzhalter aus dem
|
|
Quelltext (`Werkbaum 1.0`).
|
|
|
|
**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.
|