Pular para o conteúdo principal

Especificação, decisões e relatórios

Os documentos originais do repositório são importados a cada build, com links internos ajustados. Eles preservam o histórico e as ressalvas; a referência gerada mostra o estado atual dos símbolos.

Perguntas frequentes​

Perguntas frequentes sobre os documentos normativos e históricos do projeto.

Qual é a diferença entre “Projeto” e “Referência”?​

A referência é gerada do código atual: assinaturas, expansões, guards e usos em testes. Os documentos do projeto preservam a especificação, as decisões e os relatórios históricos, que podem descrever fases já concluídas.

Um documento histórico vale como estado atual?​

Não automaticamente. Quando especificação e código divergirem, a referência gerada mostra o que o fonte faz hoje; o relatório mostra o que foi executado na fase documentada.

Estes documentos são editados pelo gerador?​

Não. Eles são importados de docs/ e do README.md a cada build, com links internos ajustados. A fonte versionada continua sendo o arquivo original.

Onde encontro os critérios de aceitação?​

Nos documentos numerados: especificação, critérios, relatório de fase e matriz de compatibilidade. Use a navegação lateral; a ordem acompanha o prefixo numérico dos arquivos.

Os mesmos arquivos podem ser listados e reimportados pelo gerador:

ls docs/*.md
python3 tools/gerar_documentacao.py --strict