Doc Writing
Transforme un manifeste de routes scanné en documentation API Markdown groupée et modélisée pour une étape de pipeline.
Testé · Fonctionne
Ce que fait
Génère une documentation API Markdown groupée à partir d'un manifeste de routes JSON (méthode/chemin/fichier/ligne/middleware/type), en remplissant un modèle endpoint-doc.md fixe avec des tableaux de paramètres et de réponses et une icône de verrou d'authentification. Construit comme étape 2 d'un pipeline pédagogique en 3 étapes (route-scanner vers doc-writer vers quality-checker) issu d'un dépôt de cours Claude Code, il se déclenche donc spécifiquement une fois qu'un manifeste de routes existe déjà, plutôt que pour des demandes ouvertes de type « écris ma doc ».
Rapport de test
Soumis à un manifeste de 3 routes réparties sur 2 fichiers source : il a correctement scindé la sortie en products-api.md et categories-api.md en suivant le modèle endpoint-doc.md fourni (avec un vrai marqueur d'authentification 🔒 et des tableaux de paramètres/réponses) plus un manifeste files_generated lisible par machine pour l'étape suivante du pipeline — un passage de base a produit un seul fichier plat, non groupé, sans manifeste.
Testé le: 2026-07-13 · Claude Code 2.x (agent harness)
Installation
git clone https://github.com/huangjia2019/claude-code-engineering cd claude-code-engineering mkdir -p ~/.claude/skills cp -r 04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing ~/.claude/skills/doc-writing
Commandes et exemples de prompts
/doc-writingTransforme un manifeste de routes scanné en documentation API Markdown groupée et modélisée pour une étape de pipeline.
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) :
Generate Markdown API docs from this route manifest JSON we scannedFill in the endpoint doc template with params and response tables for these routesWrite grouped API reference docs from the scanned route list with auth icons