Gerador de Documentação Técnica

Este modelo de documentação técnica transforma anotações esparsas de código, comentários embutidos e detalhes de implementação em um documento limpo e bem estruturado. Ele é ideal quando você precisa de um resultado consistente para visões gerais de arquitetura, etapas de configuração, comportamento de endpoints e casos de borda — sem ter que reescrever o mesmo contexto manualmente. O prompt orienta o modelo a separar o comportamento factual das suposições, o que ajuda a reduzir alucinações e a manter a documentação alinhada com o código-fonte real.

É especialmente útil para engenheiros de backend, defensores de desenvolvedores (developer advocates) e redatores técnicos que documentam serviços após a entrega de funcionalidades ou durante trabalhos de manutenção. A saída é organizada para que os leitores encontrem rapidamente pré-requisitos, configurações, exemplos e ressalvas. Você pode adaptar o tom para wikis internos, guias voltados ao cliente ou notas de repasse ajustando as variáveis audience e voice. Também funciona muito bem quando combinado com notas de versão, porque o modelo pode resumir o que mudou e por que isso importa.

Para personalizar, cole seu material de origem em {{SOURCE_MATERIAL}}, defina o público em {{AUDIENCE}} e especifique a profundidade desejada em {{DEPTH}}. Se você quiser mais detalhes operacionais, adicione {{ENVIRONMENT}} e {{CONSTRAINTS}} para que o modelo inclua notas de implantação, dependências e limitações. A saída esperada é um documento bem acabado, com títulos, parágrafos curtos e trechos de exemplo. Para obter os melhores resultados, peça uma primeira rodada focada em precisão e, depois, uma segunda rodada focada em legibilidade e estrutura.