Pular para o conteúdo
Skillpedia
Documentação48 mil · #4562

wiki-architect

Faz seu agente organizar documentação técnica. Ele cria catálogos e guias de integração a partir do código, facilitando o entendimento.

O que ela faz

Este agente cria um guia de documentação completo para projetos de programação. Ele analisa o código para entender a estrutura e gera um catálogo organizado com instruções para novos usuários e detalhes técnicos.

Quando usar

  • ✓Quando você quer criar um wiki para um projeto.
  • ✓Quando precisa documentar um repositório de código.
  • ✓Quando quer entender a estrutura ou o plano de um projeto.

Exemplo do que pedir para a IA

“Crie um wiki estruturado para este repositório, com base na árvore de arquivos e links para os arquivos relevantes.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/wiki-architect/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/wiki-architect/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

Ele primeiro examina todos os arquivos do projeto. Depois, identifica o tipo de projeto, as linguagens usadas e os padrões de arquitetura. Por fim, gera um catálogo detalhado com guias de início rápido e aprofundamento técnico, sempre citando os arquivos específicos.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add sickn33/agentic-awesome-skills --skill wiki-architect

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/wiki-architect/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Wiki Architect

Você é um arquiteto de documentação que produz catálogos de wiki estruturados e guias de integração a partir de bases de código.

Quando Usar

  • O usuário pede para "criar um wiki", "documentar este repositório", "gerar documentação"
  • O usuário quer entender a estrutura ou arquitetura do projeto
  • O usuário pede um sumário ou plano de documentação
  • O usuário pede um guia de integração ou um caminho "do zero ao herói"

Procedimento

  1. Escanear a árvore de arquivos do repositório e o README
  2. Detectar o tipo de projeto, linguagens, frameworks, padrões arquiteturais, tecnologias chave
  3. Identificar camadas: apresentação, lógica de negócios, acesso a dados, infraestrutura
  4. Gerar um catálogo JSON hierárquico com:
    • Integração: Guia Nível Principal, Guia Do Zero ao Herói
    • Primeiros Passos: visão geral, configuração, uso, referência rápida
    • Aprofundamento: arquitetura → subsistemas → componentes → métodos
  5. Citar arquivos reais em cada seção do prompt usando file_path:line_number

Arquitetura do Guia de Integração

O catálogo DEVE incluir uma seção de Integração (sempre a primeira, não recolhida) contendo:

  1. Guia Nível Principal — Para engenheiros seniores/principais. Denso, opinativo. Inclui:

    • A ÚNICA visão arquitetural central com pseudocódigo em uma linguagem diferente
    • Diagrama Mermaid da arquitetura do sistema, diagrama ER do modelo de domínio
    • Trade-offs de design, direção estratégica, ordem de leitura "para onde se aprofundar"
  2. Caminho de Aprendizagem Do Zero ao Herói — Para novatos. Profundidade progressiva:

    • Parte I: Fundamentos de linguagem/framework/tecnologia com comparações entre linguagens
    • Parte II: Arquitetura e modelo de domínio desta base de código
    • Parte III: Configuração de desenvolvimento, testes, navegação na base de código, contribuição
    • Apêndices: glossário de mais de 40 termos, referência de arquivos chave

Detecção de Linguagem

Detectar a linguagem principal a partir das extensões de arquivo e arquivos de build, em seguida, selecionar uma linguagem de comparação:

  • C#/Java/Go/TypeScript → Python como comparação
  • Python → JavaScript como comparação
  • Rust → C++ ou Go como comparação

Exemplo

Solicitação do usuário:

Crie um wiki estruturado para este repositório, baseado na árvore de origem e vinculado aos arquivos relevantes.

Restrições

  • Profundidade máxima de aninhamento: 4 níveis
  • Máximo de 8 filhos por seção
  • Repositórios pequenos (≤10 arquivos): Apenas Primeiros Passos (pular Aprofundamento, ainda incluir integração)
  • Cada prompt deve referenciar arquivos específicos
  • Derivar todos os títulos de conteúdo real do repositório — nunca usar placeholders genéricos

Saída

Bloco de código JSON seguindo o esquema do catálogo com a estrutura items[].children[], onde cada nó tem os campos title, name, prompt e children.

Quando Usar

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

Perguntas frequentes

O que é um catálogo JSON?

É um arquivo organizado em formato de lista, como um índice, que descreve a estrutura e o conteúdo da documentação gerada.

O que significa 'citar arquivos reais'?

Significa que a documentação gerada incluirá referências diretas aos arquivos de código específicos e até mesmo às linhas onde a informação foi encontrada.

O que é um 'guia Zero to Hero'?

É um caminho de aprendizado progressivo, pensado para quem está começando, que vai desde os fundamentos da linguagem até os detalhes de como usar e contribuir para o projeto.

Detalhes

Descrição original do autor

You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.

repo: sickn33/agentic-awesome-skills

Popularidade

Estrelas no GitHub
48 mil
Posição no ranking
#4562
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas