Notre avis
Génère des documentations techniques complètes (README, spécifications, architectures, runbooks) à partir de modèles et de bonnes pratiques.
Points forts
- Utilise des modèles structurés et éprouvés
- Intègre des diagrammes Mermaid pour clarifier les concepts
- Propose une organisation logique des fichiers
- Suit un processus itératif avec révision et feedback
Limites
- Nécessite des modèles préexistants dans un dossier spécifique
- Peut générer des contenus trop génériques sans personnalisation avancée
- Dépend de la capacité à poser les bonnes questions pour comprendre le contexte
Lorsque vous devez créer ou mettre à jour une documentation technique formelle pour un projet, une API ou un processus d'exploitation.
Pour une documentation informelle ou très brève (comme un commentaire de code) ou lorsque le projet est encore trop instable pour être documenté.
Analyse de sécurité
SûrThe skill only uses Read, Write, Grep, and Glob tools to generate documentation. There are no destructive commands, no network access, and no execution of external code. The templates use placeholders and do not introduce any risk.
Aucun point d'attention détecté
Exemples
Generate a comprehensive README for my Python project that includes installation, usage, configuration, and contributing guidelines. Use the standard README template from the skills templates folder.Create a runbook for deploying my web application to production. Include steps for pre-deployment checks, deployment execution, and post-deployment monitoring. Use the runbook template.Write a technical specification for the REST API of my project, covering authentication, endpoints, request/response formats, and error handling. Follow the API documentation template.name: technical-writer description: Generate technical documentation including READMEs, specifications, architecture documents, and runbooks. Use when creating or updating any technical documentation. allowed-tools: Read, Write, Grep, Glob
Technical Writer
As a technical writer it's your job to accurately document the technical solution at hand in an engaging way.
Instructions
- Review the technical solution provided to you for documentation using the Read tool
- Follow up with any questions that would affect how you write your documentation
- Write documentation using the templates provided to you using the Write tool
- Ask for review and feedback on what you've written; If there is feedback, return to step 2
Document Templates
For documentation templates you can use see the templates folder
Templates use the %PLACEHOLDER% convention (e.g., %PROJECT NAME%, %RUNBOOK TITLE%) to mark values that should be replaced with actual content when generating documentation.
Best Practices
- READMEs should provide a comprehensive overview. See this example
- Docs and runbooks should be focussed on one subject each.
- Docs should contain relevant links to external documentation.
- Use inline or dedicated mermaid chart diagrams for diagrams
File Organization
When deciding where to put files, reference this
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Décision de Pivot Stratégique
Documentation
Documente une décision stratégique de pivot ou de persévérance avec preuves, analyse et justification. À utiliser pour évaluer s'il faut changer de cap sur un produit, une fonctionnalité ou une stratégie en fonction des retours du marché.