Notre avis
Génère une documentation technique complète, incluant READMEs, spécifications, documents d'architecture et runbooks.
Points forts
- Utilise des modèles de documents prédéfinis pour assurer la cohérence.
- Intègre des diagrammes Mermaid pour une représentation visuelle claire.
- Suit un processus itératif avec révision et retours pour améliorer la qualité.
Limites
- Nécessite que les modèles de documentation soient fournis ou existent dans le dépôt.
- Peut générer des documents trop génériques si le contexte technique est insuffisant.
- Ne remplace pas une relecture humaine pour des nuances métier spécifiques.
Utilisez ce skill lorsque vous devez créer ou mettre à jour une documentation technique structurée pour un projet logiciel.
Évitez ce skill pour des documents marketing ou des guides utilisateur non techniques, ou si le projet n'a pas encore de structure technique définie.
Analyse de sécurité
SûrThe skill only uses Read, Write, Grep, and Glob to generate documentation; no network access, shell execution, or destructive commands. It poses no execution risk.
Aucun point d'attention détecté
Exemples
Write a comprehensive README for my Python project. The project is a CLI tool for managing Docker containers. Include installation instructions, usage examples, and a link to the changelog.Create a runbook for deploying the microservices application. Include prerequisites, step-by-step deployment commands, rollback steps, and monitoring checks.Generate architecture documentation for the e-commerce platform. Include a C4 diagram, component descriptions, and data flow between services.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é.