0.1.5-alpha.4
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/300-DOCUMENTATION.md -->
|
||||
<!-- version: 4 -->
|
||||
<!-- version: 5 -->
|
||||
|
||||
# Documentation rules
|
||||
|
||||
@@ -145,6 +145,27 @@ Un répertoire générique tel que `misc/` SHOULD NOT devenir la destination par
|
||||
|
||||
Une technologie ou un projet MAY introduire des familles supplémentaires lorsqu'elles représentent une responsabilité documentaire stable.
|
||||
|
||||
## Frontière normative et pratique
|
||||
|
||||
La documentation gouvernée par PGR distingue les informations nécessaires au contrat PGR des contenus pratiques complémentaires.
|
||||
|
||||
Restent possédés par PGR lorsqu'ils sont nécessaires à la compréhension ou à l'application du référentiel :
|
||||
|
||||
- règles et contrats de gouvernance ;
|
||||
- objectifs et architecture qui définissent le sens durable du référentiel ;
|
||||
- owners normatifs ;
|
||||
- skeleton specifications minimales ;
|
||||
- templates nécessaires à un contrat réutilisable ;
|
||||
- matrices, validations et preuves directement liées aux règles.
|
||||
|
||||
Les howtos détaillés, recettes pratiques, snippets, exemples d'intégration, dépannage, comparatifs et variantes d'implémentation MAY être maintenus dans une base de connaissances séparée lorsqu'une destination réelle et autoritaire existe. SaseDev Knowledge MAY jouer ce rôle, sans devenir un owner normatif de PGR.
|
||||
|
||||
PGR MUST rester auto-suffisant : une règle PGR MUST être compréhensible et applicable sans consulter un howto ou snippet externe. Un contenu externe MAY fournir des exemples ou une aide opérationnelle, mais MUST NOT être requis pour déterminer la force, le scope ou les exigences d'une règle PGR.
|
||||
|
||||
Classifier un contenu comme pratique ne crée pas une obligation de déplacement. Une migration physique vers une base de connaissances externe MUST être une opération explicitement décidée, fondée sur une destination autoritaire fournie et vérifiée. Tant que cette condition n'est pas remplie, le contenu existant MAY rester dans PGR s'il conserve une utilité réelle.
|
||||
|
||||
Cette séparation MUST NOT créer de dépendance de PGR vers SaseDev Knowledge ou vers un autre dépôt documentaire externe.
|
||||
|
||||
## Idées, études et décisions
|
||||
|
||||
Une idée est une possibilité non engagée. Elle ne doit pas être présentée comme une décision ou une promesse de roadmap.
|
||||
|
||||
Reference in New Issue
Block a user