22 lines
2.3 KiB
Markdown
22 lines
2.3 KiB
Markdown
<!-- file: docs/rules/RULES_DOCUMENTATION.md -->
|
|
<!-- version: 2 -->
|
|
|
|
# Règles de documentation
|
|
|
|
- **DOC-001** — La documentation structurée réside sous `docs/`.
|
|
- **DOC-002** — `docs/000-README.md` est l'entrée de navigation documentaire.
|
|
- **DOC-003** — Les documents normatifs résident sous `docs/rules/`.
|
|
- **DOC-004** — Les documents d'architecture résident sous `docs/architecture/`.
|
|
- **DOC-005** — Les documents de validation résident sous `docs/validation/`.
|
|
- **DOC-006** — Les documents internes sont en français ; code, symboles et extraits techniques conservent leur langue naturelle.
|
|
- **DOC-007** — Les tableaux Markdown suivent le format contrôlé par `scripts/audit_markdown_tables.py`.
|
|
- **DOC-008** — Deux lignes blanches consécutives sont interdites hors blocs de code.
|
|
- **DOC-009** — Un fichier sous `deltas/<X.Y.Z>/` décrit exactement la tranche livrée, son état de base et ses commandes de validation ; il est immuable après livraison.
|
|
- **DOC-010** — L'historique transitoire validé réside sous `history/<X.Y.Z>/` avec un fichier immuable par jalon accepté.
|
|
- **DOC-011** — Une entrée `history/` n'est créée qu'après validation du jalon qu'elle décrit ; le résultat d'une validation future n'est jamais pré-écrit.
|
|
- **DOC-012** — Le delta suivant, ou le fix suivant lorsqu'il existe, crée l'entrée `history/` du dernier jalon définitivement validé si elle n'existe pas encore.
|
|
- **DOC-013** — `CHANGELOG.md` reste une synthèse destinée aux jalons significatifs et ne reproduit pas l'historique détaillé des `pre.*` et de leurs fixes.
|
|
- **DOC-014** — Après la structuration initiale de `0.1.0`, les `pre.*` et `.fix.*` ne modifient normalement pas `CHANGELOG.md`. Les entrées `alpha` et `beta` peuvent y apparaître uniquement lorsqu'elles correspondent à un jalon externe significatif ; `rc` et releases stables y sont les jalons privilégiés.
|
|
- **DOC-015** — `ROADMAP.md` n'est pas modifié mécaniquement à chaque delta ; il change uniquement lorsque le périmètre, l'ordre, les objectifs ou les jalons planifiés évoluent réellement.
|
|
- **DOC-016** — `history/` et `deltas/` ont des rôles distincts : `deltas/` décrit une livraison candidate et sa validation attendue ; `history/` enregistre le résultat accepté et durable.
|