Gerador de Guias de Onboarding para Wiki

Gere dois documentos de onboarding complementares que, juntos, ofereçam a qualquer engenheiro — de novato a principal — um entendimento completo de uma base de código.

Quando Usar

• O usuário pede por documentos de onboarding ou guias de início rápido
• O usuário executa o comando /deep-wiki:onboard
• O usuário quer ajudar novos membros da equipe a entender uma base de código

Detecção de Idioma

Analise o repositório em busca de arquivos de build para determinar o idioma principal dos exemplos de código:

• package.json / tsconfig.json → TypeScript/JavaScript
• *.csproj / *.sln → C# / .NET
• Cargo.toml → Rust
• pyproject.toml / setup.py / requirements.txt → Python
• go.mod → Go
• pom.xml / build.gradle → Java

Guia 1: Onboarding Nível Principal

Público: Engenheiros sêniores/staff+ que precisam do "porquê" por trás das decisões.

Seções Necessárias

1. Filosofia do Sistema e Princípios de Design — Quais invariantes o sistema mantém? Quais foram as principais escolhas de design e por quê?
2. Visão Geral da Arquitetura — Mapa de componentes com diagrama Mermaid. Quem é responsável pelo quê, padrões de comunicação.
3. Abstrações e Interfaces Chave — As abstrações de suporte de carga em que tudo depende
4. Registro de Decisões — Principais decisões arquiteturais com contexto, alternativas consideradas, trade-offs
5. Justificativa de Dependências — Por que cada dependência principal foi escolhida, o que ela substituiu
6. Fluxo de Dados e Estado — Como os dados se movem pelo sistema (rastreado a partir do código real, não adivinhado)
7. Modos de Falha e Tratamento de Erros — O que quebra, como os erros se propagam, padrões de recuperação
8. Características de Desempenho — Gargalos, limites de escalabilidade, caminhos críticos
9. Modelo de Segurança — Autenticação, autorização, limites de confiança, sensibilidade de dados
10. Estratégia de Testes — O que é testado, o que não é, filosofia de testes
11. Considerações Operacionais — Implantação, monitoramento, feature flags, configuração
12. Débito Técnico Conhecido — Avaliação honesta de atalhos e seus riscos

Regras

• Toda afirmação apoiada por citação (file_path:line_number)
• Mínimo de 3 diagramas Mermaid (arquitetura, fluxo de dados, gráfico de dependências)
• Todos os diagramas Mermaid usam cores de modo escuro (veja a skill wiki-vitepress)
• Foco no PORQUÊ as decisões foram tomadas, não apenas no QUE existe

Guia 2: Guia de Contribuidor Zero-a-Herói

Público: Novos contribuidores que precisam de orientação prática passo a passo.

Seções Necessárias

1. O Que Este Projeto Faz — Apresentação rápida de 2-3 frases
2. Pré-requisitos — Ferramentas, versões, contas necessárias
3. Configuração do Ambiente — Passo a passo com comandos exatos, saída esperada em cada etapa
4. Estrutura do Projeto — Árvore de diretórios anotada (o que fica onde e por quê)
5. Sua Primeira Tarefa — Passeio completo de ponta a ponta para adicionar um recurso simples
6. Fluxo de Trabalho de Desenvolvimento — Estratégia de branch, convenções de commit, processo de PR
7. Executando Testes — Como executar testes, o que testar, como adicionar um teste
8. Guia de Depuração — Problemas comuns e como diagnosticá-los
9. Conceitos Chave — Terminologia específica do domínio explicada com exemplos de código
10. Padrões de Código — "Se você quiser adicionar X, siga este padrão" modelos
11. Armadilhas Comuns — Erros que todo novo contribuidor comete e como evitá-los
12. Onde Obter Ajuda — Canais de comunicação, documentação, contatos chave
13. Glossário — Termos usados na base de código que não são óbvios
14. Cartão de Referência Rápida — Cheat sheet dos comandos e padrões mais usados

Regras

• Todos os exemplos de código no idioma principal detectado
• Cada comando deve ser copiável e colável
• Incluir a saída esperada para as etapas de verificação
• Usar Mermaid para diagramas de fluxo de trabalho (cores de modo escuro)
• Basear todas as afirmações em código real — citar (file_path:line_number)

Quando Usar

Esta skill é aplicável para executar o fluxo de trabalho ou as ações descritas na visão geral.

Exemplo

Solicitação do usuário:

Crie documentação de onboarding que ajude um novo engenheiro a executar, entender e modificar com segurança esta base de código.

Limitações

• Use esta skill apenas quando a tarefa corresponder claramente ao escopo descrito acima.
• Não trate a saída como substituta para validação específica do ambiente, testes ou revisão de especialistas.
• Pare e peça esclarecimentos se os inputs necessários, permissões, limites de segurança ou critérios de sucesso estiverem ausentes.