Gera um documento único e completo sobre o projeto — a base de conhecimento que serve tanto para quem desenvolve quanto para quem só precisa entender o produto.
Como utilizar
Roda sem argumentos. O comando principal só resolve o produto e a data; a leitura do projeto e a escrita do documento ficam com um agente especializado, que devolve o caminho do arquivo gerado com um resumo curto.
Exemplos
/ww:doc:project-index
Na ambiguidade
Não há o que frasear: o comando roda sobre o projeto atual e sempre gera o mesmo arquivo.
Notas
É um documento grande, que cobre o projeto inteiro. Ao terminar, você recebe o caminho do arquivo e um resumo curto — não o documento na tela.
Quando o projeto precisa de uma documentação de verdade e não existe nenhuma, ou quando a que existe está espalhada demais para servir de porta de entrada.
Um arquivo .dr_ai/docs/PROJECT_INDEX.md, organizado em dez seções:
- Visão geral do projeto
- Primeiros passos
- Arquitetura
- Funcionalidades
- Referência de API
- Componentes e módulos
- Configuração
- Guia de uso
- Perguntas frequentes e solução de problemas
- Exemplos
O documento vem com sumário navegável, referências cruzadas entre as seções, pelo menos dois diagramas e a data da última atualização logo abaixo do título.
- É um documento grande. Dependendo do projeto, fica tipicamente entre 50 e 500 KB, podendo passar disso — ele cobre o projeto inteiro, não um recorte.
- Ao terminar, você recebe o caminho do arquivo, o resultado do registro no WiseWork e um resumo de duas ou três linhas, não o documento despejado na tela.
- O documento também vai para o WiseWork. Com um produto resolvido, ele é registrado nas entradas de geração de IA do produto sob o nome fixo
project-index, vinculado às operações de geração de tasks e de features. Até 2000 linhas, vai o documento inteiro; acima disso, vai uma síntese com um resumo de cada seção, para não inflar os prompts. Sem produto fixado, o documento é gerado do mesmo jeito e o comando avisa que não registrou, apontando o /ww:init.
- Os arquivos ficam só na sua máquina. A pasta
.dr_ai/ fica fora do git: o plugin a acrescenta ao .gitignore do projeto no início da sessão. O registro no WiseWork é o que leva o conteúdo à plataforma.