diff --git a/AGENTS.md b/AGENTS.md index a0243a5..43fecab 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -21,6 +21,13 @@ The layout is **topological, not geographic**: node coordinates are schematic - **Language:** Java 21 (LTS) · **UI:** JavaFX 21 (FXML + Canvas + CSS) - **Build:** Maven · **Tests:** JUnit 5 · **Modules:** JPMS +## Feature requirements + +Requirements for new features are documented in the [`Features/`](./Features/) +folder — one Markdown file per feature. Start from the template +[`Features/feature-vorlage.md`](./Features/feature-vorlage.md); see +[`Features/README.md`](./Features/README.md) for the workflow. + ## Architecture (keep these layers separate) ``` diff --git a/Features/README.md b/Features/README.md new file mode 100644 index 0000000..a7ccb97 --- /dev/null +++ b/Features/README.md @@ -0,0 +1,14 @@ +# Features + +In diesem Ordner werden die Anforderungen für neue Features dokumentiert. + +## Vorgehen + +1. Kopiere die Vorlage [`feature-vorlage.md`](./feature-vorlage.md). +2. Benenne die Kopie sprechend (z. B. `login-mit-sso.md`). +3. Fülle die Abschnitte der Vorlage aus. +4. Lege pro Feature eine eigene MD-Datei an. + +## Enthaltene Dateien + +- [`feature-vorlage.md`](./feature-vorlage.md) – Vorlage für neue Feature-Anforderungen. diff --git a/Features/feature-vorlage.md b/Features/feature-vorlage.md new file mode 100644 index 0000000..63612ac --- /dev/null +++ b/Features/feature-vorlage.md @@ -0,0 +1,50 @@ +# Feature: + +> Vorlage zur Dokumentation von Feature-Anforderungen. +> Kopiere diese Datei und benenne sie sinnvoll (z. B. `login-mit-sso.md`), +> bevor du sie ausfüllst. + +## Übersicht + +- **Status:** Entwurf | In Umsetzung | Abgeschlossen +- **Autor:** +- **Erstellt am:** +- **Letzte Änderung:** + +## Ziel / Problemstellung + + + +## Anforderungen + +### Funktionale Anforderungen + +- [ ] +- [ ] <...> + +### Nicht-funktionale Anforderungen + +- [ ] +- [ ] <...> + +## Nutzer / Zielgruppe + + + +## Ein- und Ausgaben + +- **Eingaben:** <...> +- **Ausgaben:** <...> + +## Akzeptanzkriterien + +- [ ] +- [ ] <...> + +## Offene Fragen / Annahmen + +- <...> + +## Referenzen + +-