Guardar o porquê de uma decisão
Uma anotação curta sobre contexto, alternativas e consequências pode ajudar o próximo leitor do código.
Esta é uma publicação de exemplo para apresentar o caderno.
O código mostra como uma solução funciona. Nem sempre mostra quais restrições existiam quando ela foi escolhida.
Registrar esse contexto dá ao próximo leitor uma maneira de avaliar se a decisão ainda faz sentido.
Um registro pequeno
Uma estrutura inicial pode ter quatro partes:
- Contexto: o problema e as restrições conhecidas.
- Alternativas: os caminhos considerados e seus custos.
- Decisão: o caminho escolhido e a razão.
- Consequências: o que ficou mais simples e o que exigirá cuidado.
Um exemplo: este tipo de site
Para um caderno pessoal com publicações em Markdown, gerar páginas estáticas simplifica a hospedagem. Cada atualização de conteúdo exige um novo build, mas a leitura das páginas não depende de um banco de dados.
Se o projeto passar a precisar de conteúdo privado por usuário, vale revisar essa escolha. O registro ajuda a reconhecer quando as condições mudaram.