91 lines
3.0 KiB
Markdown
91 lines
3.0 KiB
Markdown
<!-- file: deltas/0.0.1/alpha.4.md -->
|
|
<!-- version: 1 -->
|
|
|
|
# Delta 0.0.1-alpha.4 — documentation governance
|
|
|
|
## Baseline
|
|
|
|
Version attendue avant application :
|
|
|
|
```text
|
|
0.0.1-alpha.3
|
|
```
|
|
|
|
Le history `history/0.0.1/alpha.3.md` MUST avoir été appliqué et committé avant ce delta.
|
|
|
|
Version après application :
|
|
|
|
```text
|
|
0.0.1-alpha.4
|
|
```
|
|
|
|
## Objet
|
|
|
|
Formaliser la gouvernance documentaire commune sans transformer la documentation en activité cérémonielle : responsabilités des documents, taxonomie, révisions internes, distinction vivant/historique et conservation proportionnée.
|
|
|
|
## Scope
|
|
|
|
REPLACE :
|
|
|
|
```text
|
|
VERSION
|
|
RULES.md
|
|
docs/rules/000-README.md
|
|
```
|
|
|
|
ADD :
|
|
|
|
```text
|
|
docs/rules/300-DOCUMENTATION.md
|
|
deltas/0.0.1/alpha.4.md
|
|
```
|
|
|
|
DELETE : aucun.
|
|
|
|
## Changements
|
|
|
|
- `VERSION` passe à `0.0.1-alpha.4` ;
|
|
- les rôles de `README.md`, `000-README.md`, `USAGE.md`, `RULES.md`, `ROADMAP.md`, `CHANGELOG.md` et des objectifs sont séparés ;
|
|
- une taxonomie documentaire commune est définie sans imposer de répertoires vides ;
|
|
- idées, études et décisions sont distinguées ;
|
|
- documents vivants et snapshots historiques ont des règles différentes ;
|
|
- les headers `file` / `version` sont définis comme révisions internes indépendantes de SemVer ;
|
|
- le déplacement d'un fichier met à jour son chemin et sa révision ;
|
|
- les formats stricts restent exempts de header artificiel ;
|
|
- la conservation historique est utile mais non infinie ;
|
|
- la politique linguistique de PGR interdit les sous-arbres de traduction dans le dépôt principal ;
|
|
- la documentation doit rester proportionnée et non cérémonielle.
|
|
|
|
## Validation opérateur
|
|
|
|
```bash
|
|
test "$(cat VERSION)" = "0.0.1-alpha.4"
|
|
|
|
test -f docs/rules/300-DOCUMENTATION.md
|
|
|
|
grep -Fx '<!-- file: docs/rules/300-DOCUMENTATION.md -->' docs/rules/300-DOCUMENTATION.md
|
|
grep -F "`USAGE.md` est un guide d'utilisation durable" docs/rules/300-DOCUMENTATION.md
|
|
grep -F '`ROADMAP.md` décrit la trajectoire macro du projet' docs/rules/300-DOCUMENTATION.md
|
|
grep -F '`version` est une révision interne du fichier. Elle est indépendante de `VERSION`' docs/rules/300-DOCUMENTATION.md
|
|
grep -F 'Un snapshot historique MUST NOT être réécrit silencieusement' docs/rules/300-DOCUMENTATION.md
|
|
grep -F "PGR MUST NOT créer d'arborescence `fr/`, `en/`, `de/`" docs/rules/300-DOCUMENTATION.md
|
|
grep -F 'La documentation est une aide au développement et à la maintenance, pas une fin en soi.' docs/rules/300-DOCUMENTATION.md
|
|
|
|
git diff --check
|
|
|
|
git add VERSION RULES.md docs/rules/000-README.md docs/rules/300-DOCUMENTATION.md \
|
|
deltas/0.0.1/alpha.4.md
|
|
|
|
git diff --cached --check
|
|
|
|
git status --short
|
|
```
|
|
|
|
La revue opérateur vérifie également que cette tranche ne crée aucun répertoire documentaire vide et ne mélange pas encore les règles détaillées de validation prévues pour `alpha.5`.
|
|
|
|
## Transition
|
|
|
|
PASS : enregistrer `history/0.0.1/alpha.4.md`, committer `alpha.4`, puis passer à `0.0.1-alpha.5`.
|
|
|
|
FAIL : rester dans `alpha.4` avec `alpha.4.fix.1`, sauf REPLAN si le défaut remet en cause le scope ou le plan.
|