unkos-dev/specful

Enregistrement d'un ADR avec Specful

Un ADR enregistre pourquoi une décision durable a été prise : les forces en présence, les alternatives crédibles et les conséquences. Ce n'est pas une Exigence (ce que le logiciel doit faire) ni une Conception (comment le système fonctionne) ; si le changement concerne le quoi ou le comment, chargez specful-requirement ou specful-design à la place. Restez au niveau de la décision : pas de séquences de tâches, d'inventaires de fichiers ou de notes de progression.

Flux de travail

1. Lisez docs/adr/ et son index pour la numérotation, les statuts et les décisions déjà enregistrées ; un nouvel ADR qui contredit un ADR accepté le remplace plutôt que de le contredire silencieusement.
2. Créez la structure avec specful new adr --title <TITRE>. N'allouez jamais un identifiant manuellement ; la commande possède le compteur.
3. Complétez les espaces réservés. Exprimez la décision au présent ; représentez les alternatives crédibles honnêtement plutôt que comme des hommes de paille pour une réponse préférée ; enregistrez les conséquences négatives avec le même soin que les positives. Un ADR sans alternative crédible ou sans inconvénient est de la publicité, pas un enregistrement de décision.
4. Le cycle de vie appartient au mainteneur : un nouvel enregistrement commence proposé, et seul le mainteneur l'accepte, le rejette ou le remplace.
5. Exécutez specful index, puis specful validate ; validez les vues régénérées avec la modification. Utilisez specful-review lorsque le dépôt adoptant nécessite une révision substantielle ou que l'utilisateur le demande.

Pour le profil ADR complet et les conseils champ par champ, consultez https://unkos-dev.github.io/specful/.