Notre avis
Génère de la documentation technique, y compris des README, des spécifications, des documents d'architecture et des runbooks.
Points forts
- Utilise des modèles standardisés pour assurer la cohérence
- Intègre des diagrammes Mermaid pour les schémas
- Propose une organisation claire des fichiers
Limites
- Dépend de la qualité des modèles fournis
- Nécessite des retours utilisateur pour les améliorations
- Peut ne pas couvrir tous les types de documentation spécialisée
Utilisez cette compétence lorsque vous devez créer ou mettre à jour une documentation technique pour un projet.
Ne l'utilisez pas pour de l'écriture créative ou non technique.
Analyse de sécurité
SûrThe skill only uses Read, Write, Grep, Glob tools, which perform local filesystem operations. It does not invoke external commands, network access, or destructive actions. There is no risk of data exfiltration or system compromise.
Aucun point d'attention détecté
Exemples
Write a comprehensive README for my Python project that includes installation, usage, and contribution guidelines.Create a runbook for deploying the microservice to production, including steps for rolling back.Document the architecture of the current system, including components, data flow, and a Mermaid diagram.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é.