Habilidades code-documentation-doc-generate
📦

code-documentation-doc-generate

Seguro

Generar Documentación de Código Automáticamente

Crear documentación API integral, diagramas de arquitectura, guías de usuario y referencias técnicas a partir del código fuente utilizando análisis impulsado por IA.

Soporta: Claude Codex Code(CC)
📊 71 Adecuado
1

Descargar el ZIP de la skill

2

Subir en Claude

Ve a Configuración → Capacidades → Skills → Subir skill

3

Activa y empieza a usar

Pruébalo

Usando "code-documentation-doc-generate". Generar documentación API para un servicio de usuarios FastAPI con endpoints para crear, leer, actualizar y eliminar usuarios

Resultado esperado:

  • Documentación API creada con:
  • - Especificación OpenAPI 3.0
  • - Endpoints de usuario (/users, /users/{id})
  • - Esquemas de solicitud/respuesta con validación
  • - Secciones de autenticación y autorización
  • - Comandos curl de ejemplo para cada endpoint

Usando "code-documentation-doc-generate". Crear un README para una herramienta CLI de Python que convierte imágenes a PDF

Resultado esperado:

  • README generado con:
  • - Título y descripción del proyecto
  • - Instrucciones de instalación (pip, conda)
  • - Guía de inicio rápido con ejemplos
  • - Tabla de opciones de configuración
  • - Licencia y guías de contribución

Auditoría de seguridad

Seguro
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
Archivos escaneados
692
Líneas analizadas
1
hallazgos
1
Auditorías totales
Problemas de riesgo bajo (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.
Auditado por: claude

Puntuación de calidad

38
Arquitectura
100
Mantenibilidad
87
Contenido
26
Comunidad
100
Seguridad
100
Cumplimiento de la especificación

Lo que puedes crear

Documentación API para Servicios Web

Generar automáticamente especificaciones OpenAPI y documentación API interactiva a partir de código de endpoints REST

Generación de README de Proyecto

Crear archivos README integrales con instalación, ejemplos de uso y guías de contribución

Documentación de Arquitectura

Generar diagramas de arquitectura de sistema y documentación de componentes a partir de la estructura del código

Prueba estos prompts

Documentación API Básica 
Generar documentación API para los endpoints en este código base. Incluir esquemas de solicitud/respuesta, requisitos de autenticación y ejemplos de solicitudes.
README Completo del Proyecto 
Crear un README.md integral para este proyecto. Incluir: descripción del proyecto, pasos de instalación, ejemplos de uso, opciones de configuración y guías de contribución.
Resumen de Arquitectura 
Analizar la estructura del código base y generar documentación de arquitectura. Incluir un diagrama del sistema, descripciones de componentes, flujos de datos y resumen de la pila tecnológica.
Configuración de Automatización de Documentación 
Configurar generación automatizada de documentación para este proyecto. Incluir configuración de CI/CD, reglas de linting de documentación y despliegue a una plataforma de alojamiento de documentación.

Mejores prácticas

  • Siempre verificar que la documentación generada coincida con el comportamiento real del código mediante pruebas
  • Mantener la documentación sincronizada con el código usando automatización CI/CD
  • Incluir ejemplos de código prácticos que los usuarios puedan copiar y adaptar

Evitar

  • Generar documentación sin revisar su precisión
  • Incluir información sensible como claves API o URLs internas en documentación pública
  • Crear documentación que no pueda ser verificada o probada automáticamente

Preguntas frecuentes

¿Qué tipos de documentación puede generar esta skill?
Esta skill puede generar documentación API, diagramas de arquitectura, archivos README, guías de usuario y referencias técnicas. Es compatible con especificaciones OpenAPI/Swagger, diagramas Mermaid y varios formatos de documentación.
¿Esta skill ejecuta código en mi proyecto?
No. Esta skill analiza tu código para entender su estructura y genera documentación basada en ese análisis. No modifica ni ejecuta tu código base.
¿Puedo integrar esto con mi pipeline CI/CD?
Sí. La skill incluye orientación para configurar la generación automatizada de documentación en pipelines CI/CD usando herramientas como GitHub Actions, GitLab CI o plataformas similares.
¿Qué lenguajes de programación son compatibles?
La skill funciona con cualquier lenguaje de programación. Analiza la estructura del código y genera documentación independiente del lenguaje. El soporte específico para cada lenguaje depende del formato de documentación (por ejemplo, JSDoc para JavaScript, Docstrings para Python).
¿Cómo mantengo la documentación sincronizada con mi código?
Configura la generación automatizada de documentación en tu pipeline CI para que se ejecute en cada confirmación. También puedes usar herramientas de linting de documentación para detectar inconsistencias antes del despliegue.
¿Puede esta skill documentar APIs privadas o internas?
Sí. La skill puede documentar cualquier API. Sin embargo, asegúrate de revisar la documentación generada para eliminar cualquier URL interna sensible, credenciales o información propietaria antes de compartirla externamente.

Detalles del desarrollador

Autor

sickn33

Licencia

MIT

Repositorio

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

Ref.

main

Estructura de archivos

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md