Christoph Kroczek
6e6cb0dc8d
- doc/architecture.md: arc42-Detaildokument mit Mermaid-Diagrammen (Bausteinsicht, Klassendiagramm, Statusmodell, 5 Sequenzdiagramme), Speicherkonzept, DEC-01..19-Entscheidungen mit Trade-offs - doc/requirements/: 7 Features als Gherkin-Szenarien (TDD-Grundlage) mit Traceability-Tabellen Szenario <-> Stdlib-Testname - doc/openapi.yaml: API-Vertrag fuer alle 9 Endpunkte (Quelle der Wahrheit) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# Anforderungen als Gherkin-Szenarien
|
|
|
|
Anforderungen werden als Gherkin-Szenarien (deutsche Schlüsselwörter: *Angenommen / Wenn / Dann*)
|
|
dokumentiert und im Sinne von TDD umgesetzt (DEC-REQ-01, siehe [architecture.md](../architecture.md)):
|
|
|
|
1. **Szenario schreiben** (hier, vor der Implementierung)
|
|
2. **Roten Test schreiben** — Stdlib `testing`, Testname = Szenario-Referenz aus der Traceability-Tabelle
|
|
3. **Implementieren**, bis der Test grün ist
|
|
|
|
Regeln:
|
|
|
|
- Jedes Szenario hat genau einen gleichnamigen Go-Test; die Zuordnung steht in der
|
|
Traceability-Tabelle am Ende jeder Datei.
|
|
- Wird ein Test geändert, wird das Szenario im selben Commit nachgezogen (Drift-Kontrolle).
|
|
- Szenarien beschreiben fachliches Verhalten, keine Implementierungsdetails.
|
|
|
|
## Übersicht
|
|
|
|
| Datei | Feature |
|
|
|---|---|
|
|
| [01-import-api.md](01-import-api.md) | Dokumenten-Upload über die API |
|
|
| [02-import-ordner.md](02-import-ordner.md) | Automatischer Import aus dem überwachten Ordner |
|
|
| [03-textextraktion-ocr.md](03-textextraktion-ocr.md) | Textextraktion und OCR (PDF + Bilder), Unversehrtheit der Originale |
|
|
| [04-llm-anreicherung.md](04-llm-anreicherung.md) | Optionale LLM-Anreicherung |
|
|
| [05-volltextsuche.md](05-volltextsuche.md) | Volltextsuche und Index-Rebuild |
|
|
| [06-ablage.md](06-ablage.md) | Finale Ablage in Jahresordnern |
|
|
| [07-nachvollziehbarkeit.md](07-nachvollziehbarkeit.md) | Event Sourcing, Audit-Trail, Wiederaufnahme |
|