Document Release

Audit de documentation post-livraison en neuf étapes : détecte les README, CHANGELOG et TODOs obsolètes

par DollarDill · DollarDill/beads-superpowers

Fonctionne avec configuration ★ 8.8/10

Document Release — Audit de documentation post-livraison en neuf étapes : détecte les README, CHANGELOG et TODOs obsolètes

Ce que fait

Audite chaque fichier .md dans un dépôt par rapport au diff d'une branche de fonctionnalité terminée, de sorte que les tableaux README, les notes ARCHITECTURE, CLAUDE.md, CHANGELOG et TODOS correspondent à ce qui a réellement été livré. Applique lui-même les corrections factuelles, évalue les entrées CHANGELOG par rapport à une rubrique 'what-changed/why-care/how-to-use', et refuse d'incrémenter VERSION sans demander. Se déclenche sur 'update docs', 'documentation audit', 'sync documentation' ou une branche sur le point d'être fusionnée ou PR'd.

Rapport de test

A exécuté les deux passes sur une branche réelle qui a livré un flag --json et une variable d'environnement TEXTKIT_TIMEOUT dans un dépôt avec des documents délibérément obsolètes. Le test de vente CHANGELOG de la compétence a réécrit une entrée de commit qui ne mentionnait jamais le flag livré en lignes 'You can now' destinées à l'utilisateur et a supprimé une balise interne bd-0412 du texte destiné au lecteur ; le passage sans aide a laissé cette entrée intacte et a également manqué le nouveau fichier source dans l'arborescence du projet CLAUDE.md. Il s'arrête et demande avant d'incrémenter VERSION, une décision que la référence n'a jamais soulevée. Le piège est l'intégration de Beads tissée à travers quatre de ses étapes : `bd create` a renvoyé 'no beads database found' dans un nouveau dépôt, donc prévoyez `brew install beads` plus un `bd init` par dépôt d'abord. Sa règle de diagramme signifie également qu'un diagramme d'architecture ASCII nommant une classe renommée est signalé, non corrigé.

Testé le: 2026-08-05 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/DollarDill/beads-superpowers.git
mkdir -p ~/.claude/skills
cd beads-superpowers && cp -r skills/document-release ~/.claude/skills/document-release

Commandes et exemples de prompts

  • /document-releaseAudit de documentation post-livraison en neuf étapes : détecte les README, CHANGELOG et TODOs obsolètes

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

  • This branch is done, update the docs before I open the PR
  • Run a documentation audit against this feature branch
  • Sync the README and CHANGELOG with what we actually shipped