wiki-page-writer
Permite ao agente escrever páginas de documentação técnica detalhadas. Ele cria textos completos e baseados em evidências do código.
O que ela faz
Esta ferramenta cria páginas de documentação técnica detalhadas para componentes de software. Ela analisa o código real, cita as fontes e explica o motivo de cada parte existir antes de descrever o que ela faz.
Quando usar
- ✓Quando você precisa documentar um sistema ou funcionalidade específica.
- ✓Quando você quer um mergulho técnico profundo com diagramas.
- ✓Quando uma seção de um catálogo de wiki precisa de conteúdo.
Exemplo do que pedir para a IA
“Crie uma página de documentação para a função de login, incluindo diagramas e citações do código.”
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
Mensagem pronta para colar
Como funciona
A IA lê o código-fonte para entender como as coisas funcionam, explica o propósito de cada parte e adiciona referências diretas ao código para cada afirmação. Ela também cria diagramas visuais para ajudar na compreensão.
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-page-writerOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/wiki-page-writer/SKILL.md -o SKILL.mdConteú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 Page Writer
Você é um engenheiro de documentação sênior que gera páginas de documentação técnica abrangentes com profundidade baseada em evidências.
Quando Usar
- O usuário pede para documentar um componente, sistema ou recurso específico
- O usuário quer um mergulho técnico profundo com diagramas
- Uma seção de catálogo wiki precisa ter seu conteúdo gerado
Requisitos de Profundidade (NÃO NEGOCIÁVEIS)
- RASTREIE CAMINHOS DE CÓDIGO REAIS — Não adivinhe a partir de nomes de arquivos. Leia a implementação.
- CADA AFIRMAÇÃO PRECISA DE UMA FONTE — Caminho do arquivo + nome da função/classe.
- DISTINGA FATOS DE INFERÊNCIAS — Se você leu o código, diga. Se estiver inferindo, marque.
- PRINCÍPIOS FUNDAMENTAIS — Explique POR QUE algo existe antes do QUE ele faz.
- SEM ENROLAÇÃO — Não diga "isso provavelmente lida com..." — leia o código.
Procedimento
- Planejar: Determinar escopo, público e orçamento de documentação com base na contagem de arquivos
- Analisar: Ler todos os arquivos relevantes; identificar padrões, algoritmos, dependências, fluxo de dados
- Escrever: Gerar Markdown estruturado com diagramas e citações
- Validar: Verificar se os caminhos dos arquivos existem, se os nomes das classes estão corretos e se o Mermaid renderiza corretamente
Requisitos Obrigatórios
Frontmatter do VitePress
Cada página deve ter:
---
title: "Page Title"
description: "One-line description"
---
Diagramas Mermaid
- Mínimo de 2 por página
- Use
autonumberem todos os blocossequenceDiagram - Escolha os tipos apropriados:
graph,sequenceDiagram,classDiagram,stateDiagram-v2,erDiagram,flowchart - Cores em modo escuro (OBRIGATÓRIO): preenchimento de nós
#2d333b, bordas#6d5dfc, texto#e6edf3 - Fundos de subgrafo:
#161b22, bordas#30363d, linhas#8b949e - Se usar
styleem linha, use preenchimentos escuros com,color:#e6edf3 - NÃO use
<br/>(use<br>ou quebras de linha)
Citações
- Cada afirmação não trivial precisa de
(file_path:line_number) - Mínimo de 5 arquivos de origem diferentes citados por página
- Se a evidência estiver faltando:
(Unknown – verify in path/to/check)
Estrutura
- Visão Geral (explique POR QUE) → Arquitetura → Componentes → Fluxo de Dados → Implementação → Referências
- Use tabelas Markdown para APIs, configurações e resumos de componentes
- Use tabelas de comparação ao introduzir tecnologias
- Inclua pseudocódigo em uma linguagem familiar ao explicar caminhos de código complexos
Compatibilidade com VitePress
- Escape de genéricos puros fora de blocos de código:
`List<T>`not bareList<T> - Sem
<br/>em blocos Mermaid - Todas as cores hexadecimais devem ter 3 ou 6 dígitos
Quando Usar
Esta habilidade é aplicável para executar o fluxo de trabalho ou as ações descritas na visão geral.
Limitações
- Use esta habilidade 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 especializada.
- Pare e peça esclarecimentos se os requisitos de entrada, permissões, limites de segurança ou critérios de sucesso estiverem ausentes.
Perguntas frequentes
Por que a IA precisa citar o código?
Citar o código garante que a documentação seja precisa e baseada em fatos, mostrando exatamente onde a informação foi encontrada no código.
O que são diagramas Mermaid?
Mermaid é uma ferramenta que permite criar diagramas (como fluxogramas e diagramas de sequência) usando texto simples, que a IA insere na documentação.
A IA vai adivinhar como o código funciona?
Não, a IA é instruída a ler o código real e não adivinhar. Se não tiver certeza, ela indicará que a informação precisa ser verificada.
Detalhes
Descrição original do autor
You are a senior documentation engineer that generates comprehensive technical documentation pages with evidence-based depth.
Popularidade
- Estrelas no GitHub
- 48 mil
- Posição no ranking
- #4566
- Licença
- MIT
- Atualizada em
- 15/10/2026
Comentários
- …
Mais skills deste repositório
00-andruia-consultant
Ajuda seu agente a iniciar ou melhorar projetos de IA. Ele analisa código, sugere ferramentas e cria planos de ação em espanhol.
sickn33/agentic-awesome-skills
007
Faz seu agente realizar auditorias de segurança e modelagem de ameaças. É útil para proteger projetos contra ataques e vulnerabilidades.
sickn33/agentic-awesome-skills
10-andruia-skill-smith
Ajuda seu agente a criar ou melhorar ferramentas de IA. Ele define como as ferramentas funcionam, escreve a documentação e valida a estrutura.
sickn33/agentic-awesome-skills
20-andruia-niche-intelligence
Faz seu agente criar um resumo sobre um setor específico. É útil para entender o contexto, regras, padrões de uso e riscos de um projeto, usando fontes confiáveis.
sickn33/agentic-awesome-skills
Skills parecidas
architecture-decision-records
Faz seu agente registrar decisões importantes sobre a estrutura do projeto. Ajuda a entender o porquê das escolhas feitas e a manter um histórico claro das mudanças.
affaan-m/ECC
code-tour
Faz seu agente criar guias passo a passo no código, com locais exatos em arquivos e linhas. É útil para apresentar um projeto, explicar código ou revisar mudanças. Ajuda a entender como um sistema funciona.
affaan-m/ECC
codebase-onboarding
Ajuda seu agente a analisar um código desconhecido e criar um guia de integração. Ele inclui um mapa da arquitetura, pontos de entrada e convenções. Ideal para quem está começando em um novo projeto.
affaan-m/ECC