Produz a documentação de arquitetura do repositório inteiro: cinco documentos que se complementam, cada um com um ângulo diferente, escritos em paralelo.
Como utilizar
Roda sem argumentos. Antes de disparar, o comando faz uma varredura rápida da estrutura do repositório para dividir escopos sem sobreposição e fixar um glossário comum; em seguida gera os cinco arquivos em paralelo, um por escopo.
Exemplos
/ww:doc:full-architecture
Na ambiguidade
Não há o que frasear: o comando roda sobre o repositório inteiro e sempre gera os mesmos cinco documentos.
Notas
Nada do seu código é alterado, e pastas de build e dependências ficam de fora. Cada documento tem teto de 2000 linhas.
Ao assumir a manutenção de um sistema que ninguém documentou, ou quando o time precisa de um material comum para discutir arquitetura.
Cinco arquivos na pasta architecture/, dentro da pasta de documentação do projeto:
| Arquivo | O que traz |
|---|
00-system-summary.md | O resumo que um engenheiro lê em 5 a 10 minutos: o que o sistema é, componentes principais, fluxos-chave, formato de execução, dados e integrações, riscos e por onde começar a ler o código |
01-architecture-layers.md | Camadas, fronteiras, responsabilidades, estilo arquitetural e subsistemas |
02-execution-flow.md | O caminho da execução: inicialização, ciclo de vida de uma requisição, jobs e filas, tratamento de erro, transações, observabilidade |
03-module-communication.md | Quem chama quem, contratos, integrações e pontos de acoplamento |
README.md | O índice: a documentação que já existia, o que ela cobre, o que está desatualizado, o que falta, e os links para os quatro documentos novos |
Os três mergulhos trazem caminhos reais do código, pelo menos dois diagramas cada, uma seção de módulos-chave, uma de padrões e convenções e uma de perguntas em aberto — o que não deu para confirmar olhando o código fica registrado como dúvida, não vira invenção.
- Ele não altera o seu código. O comando só cria ou atualiza os cinco documentos.
- Cada documento tem teto de 2000 linhas. Se o conteúdo cresce, ele comprime: mais tabela e bullet, menos prosa, links para o código em vez de trechos longos.
- Pastas de build e dependências são ignoradas por completo —
node_modules, dist, build, caches, coverage e afins.
- A terminologia é combinada antes de escrever, para os cinco documentos falarem dos mesmos módulos pelos mesmos nomes.
