Conrad Schulz
045e2e7202
- New repo convention: /data/<service>/ for all persistent service data (gitignored) - New repo convention: /history/prompts/ (gitignored) + /history/summary/PROJECT_CONTEXT.md for agent session logging and compressed project context - git-templates/hooks/pre-commit: quality gate checking tests + docs on every commit - git-templates/docs/: USER.md, ADMIN.md, MAINTAINER.md templates (3 target groups) - git-templates/history/summary/PROJECT_CONTEXT.md: agent context template - prompts/history.prompt.md: /history prompt for logging sessions + updating summary - copilot-bootstrap.sh: creates all new folders, .gitignore entries, installs hook - deploy.sh + deploy.fish: deploy hooks, doc templates, history template - docs/ADMIN.md: new admin handbook for this project - docs/USER.md + docs/MAINTAINER.md: updated with new conventions - git-templates/.github/copilot-instructions.md: extended DoD + new conventions - README.md: updated structure overview + prompt table
57 lines
999 B
Markdown
57 lines
999 B
Markdown
# Benutzerhandbuch – [PROJEKT_NAME]
|
||
|
||
> Zielgruppe: **Endnutzer** – Menschen, die das Produkt täglich verwenden.
|
||
> Keine Kenntnisse über interne Architektur oder Deployment notwendig.
|
||
|
||
---
|
||
|
||
## Was macht dieses Projekt?
|
||
|
||
<!-- TODO: 1-2 Sätze was das Projekt tut und welches Problem es löst -->
|
||
|
||
---
|
||
|
||
## Voraussetzungen
|
||
|
||
<!-- TODO: Was muss der Nutzer installiert haben / wissen? -->
|
||
|
||
- [ ] Anforderung 1
|
||
- [ ] Anforderung 2
|
||
|
||
---
|
||
|
||
## Erste Schritte
|
||
|
||
### Schritt 1: Installation / Zugang
|
||
|
||
<!-- TODO: Wie kommt der Nutzer an das System? -->
|
||
|
||
### Schritt 2: Erste Nutzung
|
||
|
||
<!-- TODO: Walkthrough für den häufigsten Use Case -->
|
||
|
||
---
|
||
|
||
## Hauptfunktionen
|
||
|
||
<!-- TODO: Wichtigste Features beschreiben, mit Beispielen -->
|
||
|
||
### Feature 1
|
||
|
||
### Feature 2
|
||
|
||
---
|
||
|
||
## Häufige Probleme & Lösungen
|
||
|
||
<!-- TODO: FAQ / Troubleshooting aus Nutzerperspektive -->
|
||
|
||
| Problem | Lösung |
|
||
|---------|--------|
|
||
| … | … |
|
||
|
||
---
|
||
|
||
## Support
|
||
|
||
<!-- TODO: Wo bekommt der Nutzer Hilfe? Issue-Tracker, Kontakt, etc. -->
|