Docs de Code

Ce qu'il fait

Code Docs fournit des conseils pratiques et des modèles adjacents au dépôt pour générer et maintenir la documentation dans plusieurs langages et types de projets. Il consolide les meilleures pratiques pour la structure des README, la documentation API (TypeDoc, Sphinx, godoc), les conventions de changelog (Keep a Changelog) et les docs d'architecture afin que les ingénieurs puissent rapidement produire une documentation cohérente et testable. La compétence inclut des exemples de commandes pour TypeScript, Python et Go et prescrit un flux de travail simple : identifier les besoins en documentation, générer ou mettre à jour les docs, vérifier les exemples et les liens, puis commiter avec un message clair.

Quand l'utiliser

Utilisez cette compétence lors de l'ajout de nouvelles fonctionnalités, de la modification d'API publiques, de la préparation de versions ou lorsqu'un contributeur demande « comment documenter ceci ? ». Idéal pour les mainteneurs de dépôts qui souhaitent une génération de documentation reproductible (TypeDoc, Sphinx, mkdocs) et un modèle de README minimal pour l'intégration des nouveaux projets.

Ce qui est inclus

• Scripts : Modèles et extraits de commandes de générateur (TypeDoc, JSDoc, Sphinx, pdoc, mkdocs, godoc).
• Références : Fichiers de conseils liés sous references/ pour la structure du README, les docs API, les changelogs et les docs d'architecture.
• Instructions : Étapes de flux de travail pratiques : identifier les docs à mettre à jour, exécuter les générateurs, vérifier les exemples et les liens, et commiter en utilisant des messages de commit de documentation conventionnels.

Agents compatibles

Idéalement utilisé par des agents orientés développement avec un accès au shell et aux fichiers pouvant exécuter des chaînes d'outils de langage (Node, Python, Go) ou invoquer des étapes de build de dépôt.