Geração automática de documentação técnica
De comentário do código até doc de API e diagrama de arquitetura — escreve código e doc sai
Documentação é o buraco negro de todo projeto
Código mudou 20 vezes, README ainda tá versão de 3 mês atrás. Pessoa nova vem, segue doc pra rodar, tudo dá erro. Pergunta pra você e você fala "aquele doc ficou velha".
Ninguém quer escrever doc. Dev fala "código é doc", produto fala "você escreve que eu leia depois", resultado ninguém escreve nada, fica grito de telefone.
Escreveu documento de API, foi pra produção e mudou dois campo que esqueceu de atualizar, pessoa de frontend fica de madrugada olhando pro doc velho, depois vem cobrar você.
Deixa OpenClaw cuidar de documentação
OpenClaw lê seu código fonte direto — assinatura de função, tipo de parâmetro, retorno, comentário, relação de chamada — tudo analisado, daí gera doc estruturada.
Não é aquele doc nonsense tipo "função recebe um parâmetro". Escreve propósito de cada API, parâmetro, retorno com exemplo, código de erro, tudo que precisa.
Código mudou? Roda Prompt de novo, doc atualiza automaticamente. Nunca mais doc desincronizado de código.
Prompt de gerar doc, usa direto
README, API doc, diagrama de arquitetura — 3 Prompts resolvem tudo.
Analisa código completo do projeto, gera README profissional.
README tem que ter:
1. Intro: 1-2 frase explicando o projeto
2. Feature: lista de feature em bullet points
3. Quick start: passo de install, config, rodar (copia e cola direto)
4. Estrutura: árvore de pastas + breve do que cada
5. Config: explicação de variável de ambiente e arquivo config
6. API resumida (se tiver)
7. FAQ comum
Estilo: conciso, sem enrolação. Código de exemplo tem que ser executable.Lê tudo de rota API / controller do projeto.
Gera doc padrão de API (Markdown), incluindo:
1. Caminho de rota e método (GET/POST/PUT/DELETE)
2. O que faz
3. Parâmetro de input: nome, tipo, obrigatório?, descrição, exemplo
4. Corpo do request (JSON)
5. Exemplo de resposta: sucesso e erro
6. Código de erro
7. Autenticação (se precisa token)
Agrupam por módulo, adiciona sumário de navegação.Analisa código completo e dependência entre módulo.
Gera gráfico Mermaid:
1. Diagrama de arquitetura (flowchart):
- Módulo principal e interação
- Mostra fluxo de dado
- Separa frontend, backend, banco, serviço externo
2. Diagrama de dependência de módulo (flowchart):
- import/dependência entre módulo
- Aponta módulo core vs ferramenta
3. Diagrama de fluxo de dado (sequenceDiagram):
- Business flow completo de um caso
- Da ação do usuário até banco de dados e retorna
Cada gráfico tem texto explicando design decision chave.Geração de doc: OpenClaw vs ChatGPT
Ambos geram documento, mas forma completely diferente.
- Lê código fonte do projeto, doc vem do código real
- Entende referência entre arquivo, doc de API completa e precisa
- Código atualiza depois regenera, doc sincroniza automático
- Consegue gerar gráfico Mermaid de arquitetura e sequência
- Você cola código, contexto limitado
- Não vê estrutura inteira do projeto, pula interface fácil
- Doc é uma vez só, código mudou precisa colar de novo
- Projeto grande código passa do limite de token, não consegue processar uma vez