Pular para o conteúdo

Como usar em um projeto

Este monorepo é o boilerplate: já nasce com o manifesto/ (a fonte da metodologia) e a .specs/ (a documentação viva do projeto) prontos. Para começar um projeto novo, basta clonar este repositório — o manifesto e a estrutura de .specs/ já estão no lugar.

  1. Clonar o boilerplate. O manifesto/ já vem na raiz. Ele é read-only: não se edita o manifesto dentro de um projeto. Correções e evoluções da metodologia acontecem na fonte (este repositório, na branch do manifesto) e são propagadas.

  2. A estrutura de docs do projeto já existe em .specs/:

    .specs/
    ├── adr/         ← unidades de trabalho (foco do dia a dia)
    ├── notes/       ← anotações humanas (a IA ignora — ver .specs/notes/CLAUDE.md)
    └── readme.md    ← explica a estrutura conforme ela cresce

    Outras pastas (ex.: .specs/model/, .specs/stack/) surgem quando uma ADR as cria — não se adianta estrutura que ainda não é necessária.

  3. Ajustar o CLAUDE.md na raiz do projeto. Já existe um, apontando para o manifesto e descrevendo o contexto operacional do boilerplate (comandos, setup, ambiente) — adapte-o ao seu projeto.

  4. Abrir a primeira ADR. Toda construção começa por uma ADR. O boilerplate já traz uma ADR de fundação em .specs/adr/001-fundacao-boilerplate/ como exemplo executado.

  • Universal (vem do manifesto, igual em todo projeto): o fluxo de ADR, a stack obrigatória, os padrões de manifesto/architecture/, as regras de git e segurança.
  • Do projeto (nasce nas ADRs e em .specs/stack/): regras de negócio, modelos de dados, stacks adicionais, glossário de domínio.

.specs/stack/ guarda as escolhas técnicas próprias do projeto — aquilo que vai além da stack universal definida no manifesto. O nome “stack” aqui é proposital: separa o que é do projeto do que é padrão universal (manifesto/architecture/).

Criado por Joseph Trupel