Documentação

Documentação de software é o registro escrito de uma decisão ou de um recorte do sistema, destinado a um leitor que não estava na discussão. Lê-se para completar o uso, alterar o sistema, ou recuperar o que já foi decidido.

Classificação por público e o esqueleto do documento de projeto deste tópico — e o SRS em requisitos, a recuperação do desenho na reversa e o inventário na reengenharia nos tópicos seguintes — partem desse registro.

As páginas se agrupam em dois blocos. O primeiro classifica o artefato pela pergunta do leitor; PDF, wiki e arquivo no repositório não definem o tipo.

O segundo escreve o documento de projeto de fora para dentro: propósito, critério de desempate, mapa dos blocos, decisões centrais e contrato de implementação.

Separar o clique na tela, o módulo ou a API, e a ata de pronto em três textos está em Tipos de Documentação. Declarar para que a solução existe e qual qualidade ganha no conflito está em Documento de Projeto de Software.

Classificar a especificação como contrato técnico está em Tipos de Documentação. Descrever a organização da solução, entre o que o sistema deve fazer e o fonte, está em Documento de Projeto de Software.

Arquitetura, contrato de API e o porquê de um trecho de código estão em Tipos de Documentação. Interfaces, invariantes e estruturas para implementar sem reinventar as escolhas estão em Documento de Projeto de Software.

A ata que registra quem decidiu a regra e o que ficou de fora está em Tipos de Documentação. O critério escrito junto do desenho, nas prioridades gerais, está em Documento de Projeto de Software.