Ir para o conteúdo

Documentos do projeto

Dentro de .n45/docs/ você encontra quatro arquivos gerados pelo N45 pra descrever seu projeto. Esses são a fundação que todo workflow lê antes de fazer qualquer coisa: triagem, discovery, spec, execução, validação — todos eles.

Os quatro documentos

STACK.md

O inventário técnico.

  • Linguagem e versão do runtime
  • Frameworks (web, ORM, testes, build)
  • Gerenciador de pacotes e lockfile
  • Saídas do build e onde vão

Atualizado quando o N45 detecta uma mudança nos seus arquivos de dependências ou config.

PATTERNS.md

As convenções arquiteturais do seu codebase, extraídas lendo o código real:

  • Convenções de nomes de arquivo
  • Padrões de import
  • Camadas (ex: handlers / services / repositories)
  • Estilo de tratamento de erros
  • Convenções de teste
  • Padrões de logging e observabilidade

Este é o documento que protege você do N45 gerar código que "funciona" mas quebra suas convenções.

PROJECT.md

A visão de alto nível:

  • Resumo do domínio
  • Módulos e suas responsabilidades
  • Entry points públicos (rotas, comandos CLI, APIs exportadas)
  • Dependências externas (bancos, serviços, APIs)

RUNBOOK.md

Como operar o projeto localmente:

  • Instalar dependências
  • Iniciar o servidor de dev
  • Rodar testes
  • Setup de banco e migrations
  • Comandos comuns de debug
  • Passos de deploy (se disponíveis)

/n45-status e outros workflows usam o RUNBOOK pra oferecer ações como "Rodar a aplicação".

Quando são regenerados

Gatilho O que roda
Primeira execução /n45 Todos os quatro documentos gerados do zero
Após um roadmap estruturado completar Documentos atualizados pra refletir a nova arquitetura
/n45-status sem onboarding presente Regeneração completa

Você também pode deletar um documento e o N45 regenera ele na próxima execução.

Estes documentos são gerenciados pelo N45

Não edite eles manualmente — o N45 atualiza esses arquivos conforme seu projeto evolui e suas mudanças vão ser sobrescritas. Pra influenciar o que o N45 gera, trabalhe através dos fluxos estruturados (/n45-feat, /n45-fix) — os padrões registrados pelo N45 refletem o que seu código de fato faz, não o que um arquivo markdown diz.