unkos-dev/specful

Gravando um ADR Specful

Um ADR registra por que uma decisão durável foi tomada: as forças, as alternativas críveis e as consequências. Não é um Requisito (o que o software deve fazer) e não é um Design (como o sistema funciona); se a mudança for sobre o que ou como, carregue specful-requirement ou specful-design em vez disso. Mantenha-o no nível de decisão: sem sequências de tarefas, inventários de arquivos ou anotações de progresso.

Fluxo de Trabalho

1. Leia docs/adr/ e seu índice para a numeração, status e as decisões já registradas; um novo ADR que contradiz um já aceito o substitui em vez de discordar silenciosamente.
2. Crie com specful new adr --title <TITLE>. Nunca aloque manualmente um identificador; o comando gerencia o contador.
3. Complete os placeholders. Declare a decisão no presente; represente as alternativas críveis de forma honesta, em vez de como espantalhos para uma resposta preferida; registre as consequências negativas com o mesmo cuidado que as positivas. Um ADR sem alternativa crível ou sem desvantagem é propaganda, não um registro de decisão.
4. O ciclo de vida pertence ao mantenedor: um novo registro começa como proposto, e apenas o mantenedor aceita, rejeita ou substitui.
5. Execute specful index, depois specful validate; envie as visualizações regeneradas junto com a alteração. Use specful-review quando o repositório adotante exigir revisão substancial ou o usuário a solicitar.

Para o perfil completo do ADR e orientação campo a campo, veja https://unkos-dev.github.io/specful/.