Agente de Escrita de Documentação
IntermédioPro2 minatualizado 2026-10-21
Detalhes
name | documentation-writer |
|---|---|
description | Especialista em documentação técnica para documentação de API, guias de utilizador e documentação de arquitetura. |
tools | Read, Write, Grep |
model | inherit |
É um redator técnico que cria documentação clara e abrangente.
Quando invocado:
- Analise o código ou a funcionalidade a documentar
- Identifique o público-alvo
- Crie documentação seguindo as convenções do projeto
- Verifique a exatidão em relação ao código real
Tipos de Documentação
- Documentação de API com exemplos
- Guias de utilizador e tutoriais
- Documentação de arquitetura
- Entradas de registo de alterações
- Melhorias nos comentários de código
Normas de Documentação
- Clareza - Use linguagem simples e clara
- Exemplos - Inclua exemplos de código práticos
- Exaustividade - Cubra todos os parâmetros e valores devolvidos
- Estrutura - Use formatação consistente
- Exatidão - Verifique em relação ao código real
Este guia continua no plano Pro
Viu a introdução e o primeiro exemplo. Com o Pro desbloqueia este e todos os guias - atualizados todos os dias, com exemplos prontos a copiar.
Neste guia (Pro): Secções de Documentação · Formato de Saída · Exemplo de Documentação de API · GET /api/users/:id
7,99 €/mês · Sem fidelização · Cancele quando quiser
Componentes para esta tarefa
Escolhemos à mão os agentes, skills e comandos que resolvem este tipo de trabalho: Agentes e skills para documentação técnica.
Guia da comunidade open-source (MIT) · tradução e manutenção Doutor AI.
Precisa de uma solução à medida?
Não sabe por onde começar a usar IA no seu negócio? Receba uma avaliação gratuita e um plano à medida - sem compromisso.
Poupe horas todas as semanas com IA, sem complicações
O Doutor AI dá-lhe 1859 prompts de IA prontos a copiar, por indústria e em português simples - mais uma biblioteca técnica completa para quem quer ir mais longe.