Skip to content

Commit 98fd3f9

Browse files
Tools00claude
andcommitted
docs(meta): move lessons + framework to workspace-level docs
Relocates the two meta documents one level up, from this project's docs/meta/ to Simulation-tools/docs/, so they become the shared memory across all current and future projects in the workspace: Simulation-tools/docs/simulation-project-framework.md (general) Simulation-tools/docs/lessons/pem-ec-designer.md (this project) Rationale: the whole point of these docs is that the next project reads them before starting. Keeping a copy inside each project would diverge. A single workspace-level location is the living reference. This project keeps a short pointer in docs/meta/README.md instead of the full files. The umbrella CLAUDE.md and README have been updated to reflect the new policy: "Code bleibt im Projekt, Lehren werden zentralisiert" — code stays autarkic per project, lessons pool upstream. Also closes the v0.6a (exploded-view) entry in the [Unreleased] block. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 32fc3f8 commit 98fd3f9

4 files changed

Lines changed: 49 additions & 615 deletions

File tree

CHANGELOG.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,38 @@ Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) · SemVer.
55

66
## [Unreleased]
77

8-
### Docs
9-
- **`docs/meta/lessons-learned.md`**: Ehrliche Chronik aller Entscheidungen,
8+
### Added (v0.6a — exploded-view slider)
9+
- **`draw_layer_cross_section(..., explosion_mm=0.0)`**: neuer optionaler
10+
Parameter in `src/visualization.py`. 0.0 = assembled (v0.5-Verhalten
11+
unverändert). > 0.0 = Luft-Gap nach jedem Layer, gestrichelte graue
12+
Guide-Lines zwischen Layer-Nachbarn. Layer-Dicken bleiben maßstabsgetreu.
13+
- **Streamlit Assembly-Tab**: Slider „Exploded view — gap between layers
14+
[mm]" über dem Querschnitt-Chart, 0…5 mm in 0.1er-Schritten.
15+
- **2 neue Tests** (163 + 2 xfail): `test_cross_section_exploded_view_grows_extent`,
16+
`test_cross_section_explosion_negative_raises`.
17+
- **Scope-Entscheidung:** kein v0.6b (Isometrische Pseudo-3D) und kein
18+
pyvista/STL-Import in diesem Projekt. Weitergehende 3D-/CAD-Visualisierung
19+
gehört ins Nachfolgeprojekt mit bewusster Framework-Wahl. Rationale in
20+
Workspace-Docs (siehe unten).
21+
22+
### Docs — Meta (verschoben auf Workspace-Ebene)
23+
- **`Simulation-tools/docs/lessons/pem-ec-designer.md`**: Ehrliche Chronik aller Entscheidungen,
1024
Strukturfehler und ihrer Ursachen aus pem-ec-designer v0.1–v0.6.
1125
Fünf dokumentierte Strukturfehler mit Root-Cause-Analyse:
1226
Framework ohne Trade-off-Analyse, Validation als Feature-Item,
1327
Visualisierung ohne Ziel-State, Preset-System zu spät geplant,
1428
fehlende Ziel-Nutzer-Definition.
15-
- **`docs/meta/simulation-project-framework.md`**: Allgemeines Framework
29+
- **`Simulation-tools/docs/simulation-project-framework.md`**: Allgemeines Framework
1630
für zukünftige Simulations-Projekte, direkt anwendbar.
1731
Enthält: 8 Pflichtfragen vor erstem Commit, Framework-Auswahlmatrix,
1832
Architektur-Prinzipien (Layer-Trennung, SI-Disziplin, Preset-System,
1933
Literatur-Referenzierung), Validierungs-Framework (Strict-Xfail-Strategie,
2034
Gate-Modell), Dokumentations-Framework, Fehler-Abwehr-Tabelle,
2135
Projekt-Start-Checkliste.
36+
- **`docs/meta/README.md`** (im Projekt): Pointer auf die Workspace-Docs.
37+
Die eigentlichen Inhalte liegen eine Ebene höher, damit Nachfolgeprojekte
38+
direkt davon lernen. Workspace-CLAUDE.md + README reflektieren die
39+
neue Regel „Code bleibt im Projekt, Lehren werden zentralisiert".
2240

2341
## [0.5.0] — 2026-04-21
2442

docs/meta/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Meta-Dokumentation — verschoben auf Workspace-Ebene
2+
3+
Die Lessons-Learned- und Projekt-Framework-Dokumente liegen nicht mehr
4+
in diesem Projekt, sondern **eine Ebene höher** im gemeinsamen
5+
Workspace-Ordner, damit sie für alle Simulations-Projekte nutzbar sind:
6+
7+
- **Projekt-spezifische Lessons:**
8+
`../../../docs/lessons/pem-ec-designer.md`
9+
(Absolut: `Simulation-tools/docs/lessons/pem-ec-designer.md`)
10+
11+
- **Allgemeines Framework für neue Simulations-Projekte:**
12+
`../../../docs/simulation-project-framework.md`
13+
(Absolut: `Simulation-tools/docs/simulation-project-framework.md`)
14+
15+
**Warum auf Workspace-Ebene?**
16+
17+
Die Lehren aus diesem Projekt sollen beim Start des Nachfolgeprojekts
18+
(`Simulation-tools/<projekt-2>/`) direkt gelesen werden. Eine Kopie in
19+
jedem Projekt würde divergieren; ein einziger Ort im Workspace macht
20+
das Framework zur lebenden Referenz.
21+
22+
**Wie das nächste Projekt die Docs nutzt:**
23+
24+
1. Beim Start von Projekt 2: erst `simulation-project-framework.md`
25+
durchgehen (Pflichtfragen, Framework-Auswahl, Layer-Prinzipien).
26+
2. Lessons-Datei(en) relevanter Vorprojekte lesen — hier: `pem-ec-designer.md`.
27+
3. Eigene `lessons/<projekt-2>.md` bei Projektende schreiben.
28+
4. Wiederkehrende Muster ins Framework-Dokument zurück-destillieren.

docs/meta/lessons-learned.md

Lines changed: 0 additions & 262 deletions
This file was deleted.

0 commit comments

Comments
 (0)