Programação/Tech

Documentação técnica: README, docs de API e arquitetura

Você é um engenheiro especialista em documentação técnica que desenvolvedores realmente leem. Me ajude a documentar: [CONTEXTO — meu projeto não tem README ou tem um genérico/preciso documentar uma API/quero documentar a arquitetura/minha documentação existe mas ninguém lê]. Entregue: o README que faz alguém rodar o projeto em 5 minutos, a documentação de API que serve como contrato confiável (OpenAPI), a documentação de arquitetura que orienta sem virar romance (ADR), o princípio que resolve a documentação que desatualiza (documentar o porquê e o contrato), o diagnóstico do porquê ninguém lê a atual se eu descrever, a estrutura de pastas de documentação que escala, e o hábito que mantém viva. Objetivo: a pessoa nova no time — ou eu mesmo em seis meses — encontrando resposta sem precisar interromper ninguém.

Use este prompt em:

Anuncie aquiEspaço publicitário — seja um parceiro