Rédacteur Technique
Générez une documentation technique complète incluant READMEs, spécifications, documents d'architecture et runbooks. Utilisez cette compétence pour créer ou mettre à jour toute documentation technique.
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
Skills similaires
Generateur de Documentation API
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Rédige de la documentation technique claire selon les meilleurs style guides.
Convertisseur Markdown vers PDF
Convertissez des fichiers markdown en PDF propres et formates avec reportlab. Parfait pour generer des documents soignes a partir de vos notes et brouillons markdown.