documentation
Ajuda seu agente a criar documentação técnica. Ele pode escrever arquivos README, comentários de código e documentação de API. É útil para manter o código organizado e compreensível.
O que ela faz
Esta ferramenta ajuda a criar diversos tipos de documentação para projetos de software, como manuais, descrições de código e guias de uso. Ela organiza o processo de escrita e garante que tudo fique claro e completo.
Quando usar
- ✓Quando você precisa criar a documentação de um novo projeto.
- ✓Ao escrever a descrição de como uma API funciona.
- ✓Para explicar o funcionamento interno de um código.
Exemplo do que pedir para a IA
“Crie a documentação completa para o meu projeto, incluindo README, guias de API e comentários de 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 ferramenta funciona dividindo o trabalho em etapas, como planejar a estrutura, documentar a API, explicar o código e criar manuais. Ela usa outras ferramentas menores para cada tarefa específica.
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 documentationOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/documentation/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.
Pacote de Fluxo de Trabalho de Documentação
Visão Geral
Fluxo de trabalho abrangente de documentação para gerar documentação de API, documentação de arquitetura, arquivos README, comentários de código e conteúdo técnico a partir de bases de código.
Quando Usar Este Fluxo de Trabalho
Use este fluxo de trabalho quando:
- Criar documentação de projeto
- Gerar documentação de API
- Escrever documentação de arquitetura
- Documentar código
- Criar guias do usuário
- Manter wikis
Escopo
Selecione apenas as fases necessárias para a solicitação; este pacote não autoriza todas as habilidades referenciadas ou publicações externas. Verifique cada ID e pré-requisitos locais antes da invocação. Preserve a documentação existente, distinga as decisões propostas das aceitas, mantenha dados privados fora de exemplos públicos e execute as verificações de documentação reais do projeto.
Fases do Fluxo de Trabalho
Fase 1: Planejamento da Documentação
Habilidades a Invocar
docs-architect- Arquitetura de documentaçãodocumentation-templates- Modelos de documentação
Ações
- Identificar necessidades de documentação
- Escolher ferramentas de documentação
- Planejar a estrutura da documentação
- Definir diretrizes de estilo
- Configurar o site de documentação
Prompts Copiar e Colar
Use @docs-architect to plan documentation structure
Use @documentation-templates to set up documentation
Fase 2: Documentação de API
Habilidades a Invocar
api-documenter- Documentação de APIapi-documentation-generator- Geração automáticaopenapi-spec-generation- Especificações OpenAPI
Ações
- Extrair endpoints de API
- Gerar especificações OpenAPI
- Criar referência de API
- Adicionar exemplos de uso
- Configurar geração automática
Prompts Copiar e Colar
Use @api-documenter to generate API documentation
Use @openapi-spec-generation to create OpenAPI specs
Fase 3: Documentação de Arquitetura
Habilidades a Invocar
c4-architecture-c4-architecture- Arquitetura C4c4-context- Diagramas de contextoc4-container- Diagramas de contêinerc4-component- Diagramas de componentesc4-code- Diagramas de códigomermaid-expert- Diagramas Mermaid
Ações
- Criar diagramas C4
- Documentar a arquitetura
- Gerar diagramas de sequência
- Documentar fluxos de dados
- Criar documentação de implantação
Prompts Copiar e Colar
Use @c4-architecture-c4-architecture to create C4 diagrams
Use @mermaid-expert to create architecture diagrams
Fase 4: Documentação de Código
Habilidades a Invocar
code-documentation-code-explain- Explicação de códigocode-documentation-doc-generate- Geração de documentaçãodocumentation-generation-doc-generate- Geração automática
Ações
- Extrair comentários de código
- Gerar JSDoc/TSDoc
- Criar documentação de tipos
- Documentar funções
- Adicionar exemplos de uso
Prompts Copiar e Colar
Use @code-documentation-code-explain to explain code
Use @code-documentation-doc-generate to generate docs
Fase 5: README e Primeiros Passos
Habilidades a Invocar
readme- Geração de READMEenvironment-setup-guide- Guias de configuraçãotutorial-engineer- Criação de tutoriais
Ações
- Criar README
- Escrever guia de primeiros passos
- Documentar instalação
- Adicionar exemplos de uso
- Criar guia de solução de problemas
Prompts Copiar e Colar
Use @readme to create project README
Use @tutorial-engineer to create tutorials
Fase 6: Wiki e Base de Conhecimento
Habilidades a Invocar
wiki-architect- Arquitetura de wikiwiki-page-writer- Páginas de wikiwiki-onboarding- Documentos de integraçãowiki-qa- Perguntas e Respostas da Wikiwiki-researcher- Pesquisa na Wikiwiki-vitepress- Wiki VitePress
Ações
- Projetar estrutura da wiki
- Criar páginas de wiki
- Escrever guias de integração
- Documentar processos
- Configurar site da wiki
Prompts Copiar e Colar
Use @wiki-architect to design wiki structure
Use @wiki-page-writer to create wiki pages
Use @wiki-onboarding to create onboarding docs
Fase 7: Changelog e Notas de Lançamento
Habilidades a Invocar
changelog-automation- Geração de changelogwiki-changelog- Changelog a partir do git
Ações
- Extrair histórico de commits
- Categorizar alterações
- Gerar changelog
- Criar notas de lançamento
- Preparar atualizações; publicar apenas no destino explicitamente autorizado
Prompts Copiar e Colar
Use @changelog-automation to generate changelog
Use @wiki-changelog to create release notes
Fase 8: Manutenção da Documentação
Habilidades a Invocar
doc-coauthoring- Escrita colaborativareference-builder- Documentos de referência
Ações
…
Perguntas frequentes
O que são 'skills'?
Skills são como ferramentas ou mini-programas que a IA usa para realizar tarefas específicas, como gerar documentação ou explicar código.
O que é um 'workflow bundle'?
É um conjunto de instruções e ferramentas organizadas para realizar uma tarefa maior, como a criação de toda a documentação de um projeto.
Preciso saber programar para usar isso?
Não, a ideia é que você possa pedir a documentação sem precisar entender os detalhes técnicos de programação.
Detalhes
Descrição original do autor
Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.
Popularidade
- Estrelas no GitHub
- 48 mil
- Posição no ranking
- #2871
- 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
intent-driven-development
Ajuda seu agente a transformar ideias em planos claros e testáveis. Define critérios para garantir que as mudanças sejam feitas corretamente e com segurança.
affaan-m/ECC
product-capability
Orienta seu agente a transformar ideias de produtos em planos claros. Define o que precisa ser feito, os limites e as decisões antes do desenvolvimento.
affaan-m/ECC
article-writing
Escreve conteúdos longos como artigos, guias e posts de blog com um estilo único. É útil quando você precisa de textos bem escritos, com voz consistente e credibilidade.
affaan-m/ECC