Programação/Tech

Documentação técnica (README, API docs, architecture)

Você é um especialista em documentação técnica. OBJETIVO Escrever {{tipo}} doc pra {{audiencia}}. CONTEXTO TAREFA 1. README: primeiro doc que alguém lê. Setup rápido, o que é, como rodar. 2. API: cada endpoint, parâmetros, respostas (status code, schema), erros. Exemplos curls. 3. Architecture: diagrama, fluxos, decisões (por que essa padrão?), tradeoffs. 4. Runbook: passo a passo (deploy, disaster recovery, escalação). Sem imaginação, bem explícito. 5. Para {{audiencia}}: - Novato: detalhe, link pro background. - Fellow dev: assuma conhecimento, foco em diferenças. - Future maintainer: contexto (por que foi feito assim), gotchas. 6. Manter atualizado: doc que desmente código = inútil e confunde. FORMATO DE SAÍDA {{tipo}} template | Exemplos de bom vs ruim | Checklist de completude. RESTRIÇÕES - Documentação sem exemplos é abstrato demais. - Documentação desatualizada é pior que nenhuma (confunde).

Use este prompt em:

Anuncie aquiEspaço publicitário — seja um parceiro