Compétences code-documentation-doc-generate
📦

code-documentation-doc-generate

Sûr

Gerar Documentação de Código Automaticamente

Crie documentação abrangente de API, diagramas de arquitetura, guias do usuário e referências técnicas a partir do código-fonte usando análise alimentada por IA.

Prend en charge: Claude Codex Code(CC)
🥉 75 Bronze
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "code-documentation-doc-generate". Generate API documentation for a FastAPI user service with endpoints for create, read, update, delete users

Résultat attendu:

  • Documentação de API criada com:
  • - Especificação OpenAPI 3.0
  • - Endpoints de usuário (/users, /users/{id})
  • - Schemas de requisição/resposta com validação
  • - Seções de autenticação e autorização
  • - Comandos curl de exemplo para cada endpoint

Utilisation de "code-documentation-doc-generate". Create a README for a Python CLI tool that converts images to PDF

Résultat attendu:

  • README gerado com:
  • - Título e descrição do projeto
  • - Instruções de instalação (pip, conda)
  • - Guia de início rápido com exemplos
  • - Tabela de opções de configuração
  • - Diretrizes de licença e contribuição

Audit de sécurité

Sûr
v1 • 2/25/2026

All 91 static findings are false positives triggered by documentation examples in the skill. The skill provides templates and examples for generating documentation. No actual code execution, network calls, or credential access occurs. Risk level: SAFE.

2
Fichiers analysés
692
Lignes analysées
1
résultats
1
Total des audits
Problèmes à risque faible (1)
resources/implementation-playbook.md:1-641SKILL.md:1-51
Static Scanner Pattern Detection in Documentation Examples
The static scanner detected 91 potential security patterns in documentation examples. These findings are false positives triggered by template variables (${VARIABLE}), code block fences (```), and example URLs in the implementation playbook. No actual code execution, network calls, or credential access occurs.
Audité par: claude

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
50
Communauté
100
Sécurité
100
Conformité aux spécifications

Ce que vous pouvez construire

Documentação de API para Serviços Web

Gere automaticamente especificações OpenAPI e docs de API interativas a partir de código de endpoints REST

Geração de README do Projeto

Crie arquivos README abrangentes com instalação, exemplos de uso e diretrizes de contribuição

Documentação de Arquitetura

Gere diagramas de arquitetura do sistema e documentação de componentes a partir da estrutura do código

Essayez ces prompts

Documentação Básica de API 
Generate API documentation for the endpoints in this codebase. Include request/response schemas, authentication requirements, and example requests.
README Completo do Projeto 
Create a comprehensive README.md for this project. Include: project description, installation steps, usage examples, configuration options, and contribution guidelines.
Visão Geral da Arquitetura 
Analyze the codebase structure and generate architecture documentation. Include a system diagram, component descriptions, data flows, and technology stack summary.
Configuração de Automação de Documentação 
Set up automated documentation generation for this project. Include CI/CD configuration, doc linting rules, and deployment to a documentation hosting platform.

Bonnes pratiques

  • Sempre verifique se a documentação gerada corresponde ao comportamento real do código através de testes
  • Mantenha a documentação sincronizada com o código usando automação de CI/CD
  • Inclua exemplos de código práticos que os usuários podem copiar e adaptar

Éviter

  • Gerar documentação sem revisar quanto à precisão
  • Incluir informações sensíveis como chaves de API ou URLs internas em docs públicas
  • Criar documentação que não pode ser verificada ou testada automaticamente

Foire aux questions

Que tipos de documentação esta habilidade pode gerar?
Esta habilidade pode gerar documentação de API, diagramas de arquitetura, arquivos README, guias do usuário e referências técnicas. Suporta especificações OpenAPI/Swagger, diagramas Mermaid e vários formatos de documentação.
Esta habilidade executa código no meu projeto?
Não. Esta habilidade analisa seu código para entender sua estrutura e gera documentação com base nessa análise. Não modifica ou executa sua base de código.
Posso integrar isso com meu pipeline de CI/CD?
Sim. A habilidade inclui orientação para configurar geração automática de documentação em pipelines de CI/CD usando ferramentas como GitHub Actions, GitLab CI ou plataformas similares.
Quais linguagens de programação são suportadas?
A habilidade funciona com qualquer linguagem de programação. Ela analisa a estrutura do código e gera documentação agnóstica à linguagem. O suporte específico da linguagem depende do formato de documentação (por exemplo, JSDoc para JavaScript, Docstrings para Python).
Como mantenho a documentação sincronizada com meu código?
Configure geração automática de docs em seu pipeline de CI para executar em cada commit. Você também pode usar ferramentas de linting de docs para capturar inconsistências antes da implantação.
Esta habilidade pode documentar APIs privadas ou internas?
Sim. A habilidade pode documentar qualquer API. No entanto, certifique-se de revisar a documentação gerada para remover URLs internas sensíveis, credenciais ou informações proprietárias antes de compartilhar externamente.

Détails du développeur

Auteur

sickn33

Licence

MIT

Dépôt

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

Réf

main

Structure de fichiers

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md