docs-governance

Par cherryhq · cherry-studio

À utiliser lors de la rédaction, la restructuration, l'audit ou la révision de la documentation du dépôt Cherry Studio, des READMEs, des JSDoc, des commentaires, des instructions d'Agent ou des docs anglais/chinois appairés, y compris les vérifications d'impact sur la documentation liée aux sources.

npx skills add https://github.com/cherryhq/cherry-studio --skill docs-governance

Gouvernance de la documentation

Exigez un périmètre explicite. Lisez le AGENTS.md applicable, puis le README du module ou de la source propriétaire avant de juger le texte.

Placer le fait

  • Le comportement transversal et multi-module appartient à docs/references/<domain>/.
  • Le processus du repository appartient à docs/contrib/.
  • Le comportement privé du module appartient à côté du module.
  • La rationale durable et les alternatives rejetées appartiennent aux Agent Notes.
  • Les ordres d'agent permanents appartiennent au AGENTS.md le plus spécifique applicable et font un lien vers leur rationale.

Gardez un seul endroit par fait. Un README de domaine possède son sujet et résume les enfants avec des liens ; il ne copie pas leur détail d'implémentation. Un tutoriel guide à travers des actions ordonnées vers un résultat observable. Une référence supporte la recherche et énonce le comportement actuel.

Inspecter l'impact sur le code

Exécutez pnpm change:scope --base <verified-ref> et pnpm docs:affected --base <verified-ref>. Inspectez chaque document retourné par rapport au comportement modifié. Une correspondance de source-prefix est une demande de révision obligatoire, non une preuve que le texte a besoin d'une diff.

Les docs de référence décrivent la réalité actuelle. Préservez le comportement, l'échec, le timing, la propriété, la modalité, les exceptions et les conséquences. Supprimez la narration d'implémentation, les transcriptions de raisonnement, l'historique de révision, la rationale dupliquée, les inventaires de statut et les catalogues dont la source ou le générateur en est déjà propriétaire.

Docs générées et appariées

Les docs de référence portent description et sources ; les docs contrib et de gouvernance portent description. Ne modifiez jamais à la main docs/README.md, docs/sources-index.json ou docs/i18n/terminology.md.

Pour une paire dans le périmètre, lisez le contrat d'appairage, les règles de traduction et la terminologie. Mettez à jour la contrepartie minimalement et réenregistrez uniquement après révision sémantique. Utilisez translate-docs pour les nouvelles paires ou la traduction par lot.

Validation

Le travail de documentation seul exécute pnpm docs:check. Les modifications de script, hook, commentaire de code ou skill exécutent également des tests ciblés, pnpm lint, pnpm test:lint et git diff --check le cas échéant.

Skills similaires