Pular para o conteúdo

/ww:doc:project-index

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.

/ww:doc:project-index

DocCompatível com ww 1.7.3

Como utilizar

Roda sem argumentos. O comando captura só o diretório de documentos e a data, e 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 PROJECT_INDEX.md na pasta de documentação do projeto, organizado em dez seções:

  1. Visão geral do projeto
  2. Primeiros passos
  3. Arquitetura
  4. Funcionalidades
  5. Referência de API
  6. Componentes e módulos
  7. Configuração
  8. Guia de uso
  9. Perguntas frequentes e solução de problemas
  10. 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 e um resumo de duas ou três linhas, não o documento despejado na tela.