// skills embutidas · 05
code-wiki
Gera uma wiki navegável de um codebase: overview, arquitetura, módulos, diagramas Mermaid e guia de onboarding.
Metadata
params source bundled Instalada por padrão no repositório Okami-Agent. path file skills/code-wiki/SKILL.md triggers keywords wiki, documentação, docs, arquitetura, diagrama, mermaid, onboarding, codebase loaded by tool use_skill carrega o corpo completo quando a tarefa casa com a skill.
Quando usar
- Onboarding técnico de um repo.
- Documentar arquitetura e módulos principais.
- Criar diagramas Mermaid lastreados no código real.
Quando não usar
- Documentar um único arquivo.
- Código mudando ativamente na mesma sessão.
- Quando o usuário precisa de API reference gerada por ferramenta específica.
Fluxo recomendado
- Escaneie estrutura e imports.
- Escolha 8-10 módulos por relevância.
- Crie
docs/wiki/README.md,architecture.md, docs por módulo e getting started. - Verifique cada nó do diagrama no código.
Regras
- Cap inicial de ~20 nós por diagrama.
- Sem inventar componente ou relação.
- Use caminhos relativos para repo local.
Checklist de conclusão
- Wiki criada em
docs/wiki/. - Diagramas batem com arquivos reais.
- Overview aponta módulos certos.