/ww:doc:code-summary

Cria (ou atualiza) um resumo curto do projeto voltado a quem vai desenvolver nele: tecnologias, padrões de arquitetura, módulos principais, convenções de código e onde encontrar a documentação que já existe. O arquivo tem no máximo 90 linhas — é um cartão de orientação, não um manual.

/ww:doc:code-summary

DocCompatível com ww 1.7.3Modelo: sonnet

Como utilizar

Roda sem argumentos: é só chamar /ww:doc:code-summary. Ele varre o código-fonte e a documentação, sintetiza o contexto e grava o resumo em no máximo 90 linhas.

Exemplos

/ww:doc:code-summary

Na ambiguidade

Não há o que frasear: o comando roda sobre o projeto atual e sempre gera o mesmo arquivo.

Notas

Sem produto fixado, o comando gera o documento localmente do mesmo jeito — só não é registrado no WiseWork, e o comando avisa.

Quando usar

Ao trazer alguém novo para o projeto, ou para dar ao seu assistente um contexto enxuto e confiável antes de começar a trabalhar.

O que acontece

1. O comando descobre a documentação existente — README, guias de contribuição, arquivos de configuração e o que houver na pasta de documentação.
2. Analisa o código: pontos de entrada, estrutura de diretórios, módulos principais e as convenções em uso (estilo de import, nomenclatura, tratamento de erro, gerenciamento de estado, padrões de teste).
3. Localiza a documentação técnica por categoria: esquemas de banco, documentação de API, documentos de arquitetura, documentos de design, configuração, deploy e definições de tipos.
4. Junta tudo no que um desenvolvedor novo precisa saber de imediato, nos limites críticos e em onde buscar o detalhe.
5. Salva em CODE_SUMMARY.md, dentro da pasta de documentação do projeto, com a data no topo.
6. Se houver um produto do WiseWork resolvido, registra o mesmo conteúdo nas entradas de geração de IA do produto, sob um nome fixo — assim ele fica disponível para o restante da plataforma.

Bom saber

• O registro no WiseWork é um bônus, não um requisito. Se nenhum produto estiver fixado, o comando gera o documento localmente do mesmo jeito e avisa que não registrou, apontando o /ww:init. Um erro nesse registro nunca derruba a geração.
• Rodar de novo atualiza, em vez de duplicar: o registro no WiseWork sempre substitui o anterior.
• 90 linhas é um teto rígido. Se você quer profundidade, o comando certo é outro.

Ver também

• /ww:doc:project-index — para a documentação completa do projeto
• /ww:codebase-map — para o mapa detalhado do codebase