Notre avis
Ce skill génère de la documentation technique (READMEs, spécifications, documents d'architecture, runbooks) en suivant des modèles et des bonnes pratiques.
Points forts
- Utilise des modèles structurés pour garantir une cohérence
- Inclut des diagrammes Mermaid pour les schémas
- Propose des bonnes pratiques d'organisation et de liens externes
- Permet des révisions itératives avec retour d'expérience
Limites
- Dépend de la qualité des modèles fournis
- Nécessite des informations précises de la part de l'utilisateur
- Peut ne pas couvrir tous les cas spécifiques sans adaptation
Idéal pour créer ou mettre à jour de la documentation technique de manière structurée et professionnelle.
À éviter si vous préférez rédiger manuellement ou si la documentation n'est pas nécessaire pour le projet.
Analyse de sécurité
SûrThe skill only uses Read, Write, Grep, and Glob to generate documentation; no network, code execution, or destructive commands. No risk of data exfiltration or system compromise.
Aucun point d'attention détecté
Exemples
Generate a README for my Python project using the template at ./templates/readme-template.md. The project is called 'DataPipeline' and it processes CSV files.Create a runbook for deploying the application 'MyApp' to production. Use the runbook template in ./templates/ and include a Mermaid sequence diagram for the deployment steps.Write an architecture document for a microservices system with three services: Auth, Orders, and Payments. Use the architecture template and include a Mermaid component 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.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.