Notre avis
Génère des documentations techniques telles que des README, des spécifications, des documents d'architecture et des runbooks à partir de solutions techniques.
Points forts
- Utilise des templates structurés pour une documentation cohérente
- Intègre des diagrammes Mermaid pour des explications visuelles
- Permet de réviser et d'améliorer le contenu grâce à des retours itératifs
- Organise les fichiers selon des conventions claires
Limites
- Nécessite que l'utilisateur fournisse une solution technique détaillée en entrée
- Les templates doivent être préexistants dans le dossier ./templates/
- Peut nécessiter des ajustements manuels pour des formats très spécifiques
Idéal pour créer ou mettre à jour n'importe quelle documentation technique, notamment README, spécifications, architecture ou runbooks.
À éviter pour des documentations très créatives ou marketing qui ne suivent pas une structure technique standard.
Analyse de sécurité
SûrThe skill uses only Read, Write, Grep, Glob — standard file operations. There are no network calls, code execution, or destructive commands, and no obfuscated payloads. It poses no meaningful security risk.
Aucun point d'attention détecté
Exemples
Generate a comprehensive README for this Python project using the readme-template.md. The project is a CLI tool for file conversion.Create a runbook for deploying the microservices application using the runbook template. Include a Mermaid flowchart of the deployment process.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.