Habilidades documentation-generation-doc-generate
📦

documentation-generation-doc-generate

Seguro

Gerar documentação abrangente a partir do código

Mantenha sua documentação sincronizada com o código automaticamente. Esta habilidade extrai informações do código-fonte para criar especificações de API, diagramas de arquitetura e guias do usuário que permanecem atualizados conforme sua base de código evolui.

Suporta: Claude Codex Code(CC)
🥉 75 Bronze
1

Baixar o ZIP da skill

2

Upload no Claude

Vá em Configurações → Capacidades → Skills → Upload skill

3

Ative e comece a usar

Testar

A utilizar "documentation-generation-doc-generate". Analyze Python API routes in src/routes/

Resultado esperado:

  • Arquivo de especificação OpenAPI 3.0 (openapi.yaml)
  • Página HTML de documentação interativa da API
  • Exemplos de código em Python, JavaScript e cURL para cada endpoint

A utilizar "documentation-generation-doc-generate". Document the microservices architecture

Resultado esperado:

  • Diagrama de arquitetura do sistema mostrando relacionamentos entre serviços
  • Documentação de componentes com stacks de tecnologia e responsabilidades
  • Diagramas de fluxo de dados para processos de negócio principais

Auditoria de Segurança

Seguro
v1 • 2/24/2026

This skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.

2
Arquivos analisados
692
Linhas analisadas
0
achados
1
Total de auditorias
Nenhum problema de segurança encontrado
Auditado por: claude

Pontuação de qualidade

38
Arquitetura
100
Manutenibilidade
87
Conteúdo
50
Comunidade
100
Segurança
100
Conformidade com especificações

O Que Você Pode Construir

Geração de Documentação de API

Gere automaticamente especificações OpenAPI e documentação interativa de API a partir de anotações do código e definições de rotas.

Documentação de Arquitetura

Crie diagramas de arquitetura do sistema e documentação de componentes analisando imports, dependências e estrutura do código.

Automação de Pipeline de Documentação

Configure fluxos de trabalho de CI/CD que regeneram e implantam documentação em cada commit de código para manter docs sincronizados.

Tente Estes Prompts

Documentação Básica de API 
Analyze the Python files in ./src/api/ directory and generate OpenAPI 3.0 specification with all endpoints, request/response schemas, and authentication requirements.
Geração de README 
Create a comprehensive README.md for this repository including installation instructions, configuration options, usage examples, and contribution guidelines based on the code structure.
Diagramas de Arquitetura 
Examine the service modules and their imports to create Mermaid diagrams showing system architecture, data flow, and component dependencies.
Suíte Completa de Documentação 
Generate complete documentation including API reference, architecture overview, getting started guide, and deployment instructions. Set up a documentation site using the generated artifacts with search functionality.

Melhores Práticas

  • Execute geração de documentação como parte do CI/CD para manter docs sincronizados com mudanças de código
  • Inclua verificações de cobertura de documentação que falham builds quando cobertura cai abaixo do limite
  • Revise a documentação gerada quanto à precisão e adicione contexto humano quando necessário

Evitar

  • Gerar documentação uma vez e nunca atualizá-la conforme o código evolui
  • Publicar documentação gerada sem revisão humana quanto à precisão
  • Incluir informações sensíveis como chaves de API ou URLs internas em docs gerados

Perguntas Frequentes

Quais linguagens de programação são suportadas para geração de documentação?
A habilidade funciona melhor com Python, JavaScript, TypeScript e Go. Pode analisar outras linguagens com extração de documentação baseada em AST, mas pode ter suporte limitado para linguagens menos comuns.
Esta habilidade pode gerar documentação para repositórios privados?
Sim, ao executar dentro do Claude Code ou Codex com acesso ao seu repositório, a habilidade pode analisar e gerar documentação para bases de código privadas.
Como mantenho a documentação gerada atualizada?
Configure um fluxo de trabalho de CI/CD que aciona regeneração de documentação em mudanças de código. A habilidade inclui fluxos de trabalho de exemplo do GitHub Actions para pipelines de documentação automatizada.
Quais formatos de documentação podem ser gerados?
Especificações OpenAPI/Swagger, documentação Markdown, diagramas Mermaid, sites de documentação HTML e reStructuredText para integração Sphinx.
Esta habilidade substitui escritores técnicos humanos?
Não. Automatiza tarefas repetitivas de documentação e gera documentação de referência, mas escritores humanos são essenciais para conteúdo narrativo, tutoriais e garantir qualidade da documentação.
Quão precisa é a documentação gerada?
A precisão depende da qualidade do código e anotações. Código bem documentado com type hints e docstrings produz melhores resultados. Sempre revise a documentação gerada antes de publicar.

Detalhes do Desenvolvedor

Autor

sickn33

Licença

MIT

Repositório

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-generation-doc-generate

Referência

main

Estrutura de arquivos

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md