4e72ddc32f
Discovery synthesis, docs tree, Python src layout, CLAUDE.md, pyproject.toml. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
49 lines
2.3 KiB
Markdown
49 lines
2.3 KiB
Markdown
<!-- Type: reference (Diataxis). Style: index de navigation, structure de la doc. -->
|
|
|
|
# Documentation — gitea-dashboard
|
|
|
|
## Structure
|
|
|
|
```
|
|
docs/
|
|
├── project/ # Pilotage projet
|
|
│ ├── descriptif.md # Brief initial (etape 3)
|
|
│ └── demandes.md # Inbox features (/workflow demande)
|
|
├── technical/ # Architecture et decisions
|
|
│ ├── ARCHITECTURE.md # Architecture technique (etape 6, architect)
|
|
│ ├── decisions.md # ADR (Architecture Decision Records)
|
|
│ └── research.md # Resultats de recherche (etape 4, researcher)
|
|
├── discovery/ # Livrables discovery (etape 1, majeur uniquement)
|
|
│ └── synthesis.md # Synthese d'interview
|
|
├── plans/ # Plans de version (etape 6)
|
|
│ └── vX.Y.Z-plan.md # Un plan par version (architect)
|
|
├── guides/ # Documentation utilisateur (optionnel)
|
|
│ └── [sujet].md # deployment.md, api-usage.md, getting-started.md
|
|
├── dev/ # Notes de developpement (optionnel)
|
|
│ └── [sujet].md # setup.md, conventions.md, troubleshooting.md
|
|
└── README.md # Ce fichier
|
|
```
|
|
|
|
## Conventions
|
|
|
|
- **MAJUSCULES.md** : documents officiels et de pilotage (ARCHITECTURE, CHANGELOG)
|
|
- **minuscules.md** : documents de travail et notes (descriptif, demandes, research, decisions)
|
|
- **Nommage fichiers** : minuscules, tirets pour separer les mots (deployment.md, api-usage.md)
|
|
- Les dossiers `guides/` et `dev/` sont crees quand le besoin apparait
|
|
- Chaque document a un emplacement unique — pas de doc ailleurs que dans cette arborescence
|
|
- **Roadmap** : Gitea milestones (pas de ROADMAP.md local)
|
|
- **Backlog** : Gitea issues avec label `backlog` (pas de BACKLOG.md local)
|
|
|
|
## Ou mettre ma doc ?
|
|
|
|
| Type de doc | Ou |
|
|
|-------------|-----|
|
|
| Guide utilisateur (install, usage, config) | `guides/` |
|
|
| Notes dev (setup, conventions, debug) | `dev/` |
|
|
| Architecture, ADR, recherche | `technical/` |
|
|
| Brief, demandes | `project/` |
|
|
| Plan de version | `plans/` |
|
|
| Synthese discovery | `discovery/` |
|
|
| Roadmap, jalons | Gitea milestones |
|
|
| Backlog, idees, dette technique | Gitea issues (label `backlog`) |
|