Pular para o conteúdo
Desenvolvimento

Documentação viva com IA: ADRs, README

Documentação boa é decisão registrada, não parágrafo bonito. IA acelera rascunho; humano carimba verdade.

TL;DR

Documentação viva com IA: ADRs, README. Documentação boa é decisão registrada, não parágrafo bonito. IA acelera rascunho; humano carimba verdade.

ADR enxuto

Contexto, decisão, consequências. Um arquivo por decisão evita wiki morta. Em projetos bilíngues, pode valer um parágrafo em inglês para stakeholders externos.

README que junior usa

Comandos copy-paste, variáveis de ambiente exemplo e troubleshooting dos três erros mais comuns. IA lista bem passos; você valida versão de Node e Docker.

Leitura relacionada no hub

Este artigo aprofunda um recorte do tema principal. Para a visão geral que originou esta série, abra o post de referência: Agile coding com IA. Use os links internos para navegar entre os spokes sem perder contexto.