Habilidades Reference Builder
📦

Reference Builder

Seguro

Generar documentación API y técnica integral

Crear documentación de referencia exhaustiva manualmente consume mucho tiempo y es propenso a errores. Esta habilidad automatiza la generación de materiales de referencia completos con formato consistente y cobertura completa de parámetros.

Soporta: Claude Codex Code(CC)
📊 69 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 "Reference Builder". Documenta un endpoint REST API: POST /api/users con parámetros: name (string, required), email (string, required), age (integer, optional)

Resultado esperado:

  • ### POST /api/users
  •  
  • **Descripción**: Crea una nueva cuenta de usuario en el sistema.
  •  
  • **Parámetros**:
  • - `name` (string, required): Nombre completo del usuario, 2-100 caracteres
  • - `email` (string, required): Dirección de email válida, debe ser única
  • - `age` (integer, optional): Edad del usuario en años, 18-120
  •  
  • **Retorna**: Objeto Usuario con id, name, email, created_at
  •  
  • **Errores**: 400 (validación), 409 (email duplicado), 500 (error de servidor)
  •  
  • **Ejemplo**:
  • POST /api/users
  • {"name": "Jane Doe", "email": "jane@example.com", "age": 30}

Usando "Reference Builder". Documenta un esquema de base de datos User con campos: id, username, email, created_at, status

Resultado esperado:

  • ### Esquema User
  •  
  • | Campo | Tipo | Restricciones | Descripción |
  • |-------|------|-------------|-------------|
  • | id | UUID | PRIMARY KEY | Identificador único |
  • | username | VARCHAR(50) | NOT NULL, UNIQUE | Nombre de visualización del usuario |
  • | email | VARCHAR(255) | NOT NULL, UNIQUE | Dirección de email de contacto |
  • | created_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | Tiempo de creación de cuenta |
  • | status | ENUM | NOT NULL, DEFAULT 'active' | Estado de cuenta: active, suspended, deleted |
  •  
  • **Índices**: username_idx, email_idx, status_idx
  •  
  • **Relaciones**: Uno-a-muchos con Posts, Uno-a-uno con Profile

Auditoría de seguridad

Seguro
v1 • 2/24/2026

This is a prompt-only skill containing no executable code. Static analysis scanned 0 files with 0 lines of code and detected no security patterns. The skill consists entirely of documentation instructions and prompt templates for creating technical references.

0
Archivos escaneados
0
Líneas analizadas
0
hallazgos
1
Auditorías totales
No se encontraron problemas de seguridad
Auditado por: claude

Puntuación de calidad

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

Lo que puedes crear

Generación de Referencia API

Crear documentación API integral para APIs internas o públicas con listados completos de parámetros, tipos de retorno, códigos de error y ejemplos de uso.

Documentación de Configuración

Generar guías de configuración detalladas para aplicaciones complejas, documentando todas las configuraciones, predeterminados, restricciones y valores específicos por entorno.

Documentación de SDK

Producir materiales de referencia de SDK exhaustivos incluyendo jerarquías de clases, signaturas de métodos, definiciones de tipos y ejemplos de integración.

Prueba estos prompts

Documentación Básica de Método API 
Documenta el siguiente endpoint API como una entrada de referencia completa. Incluye la signatura del método, todos los parámetros con tipos y restricciones, valores de retorno, errores posibles y un ejemplo de uso básico:

Endpoint: [METHOD] [URL]
Parameters: [list parameters]
Context: [describe what it does]
Referencia de Parámetros de Configuración 
Crea una tabla de referencia de configuración integral para las siguientes configuraciones. Para cada parámetro, documenta el tipo, valor predeterminado, rango válido, si es requerido, nombre de variable de entorno y cualquier dependencia de otras configuraciones:

[Provide list of configuration parameters]
Documentación de Esquema con Ejemplos 
Genera documentación de esquema completa para el siguiente modelo de datos. Incluye tipos de campo, reglas de validación, restricciones, relaciones con otros modelos, información de indexación y proporciona tres ejemplos: un registro válido mínimo, un registro completamente poblado y un caso límite:

[Provide schema definition]
Guía de Referencia de Módulo Completa 
Crea una referencia técnica completa para el siguiente módulo. Estructúrala con: 1) Sección de visión general explicando el propósito, 2) Tabla de referencia rápida de todos los métodos públicos, 3) Entradas detalladas para cada método con signaturas, parámetros, tipos de retorno, errores y ejemplos, 4) Referencias cruzadas entre métodos relacionados, 5) Consideraciones de rendimiento, y 6) Errores comunes a evitar:

[Provide module source code or interface definition]

Mejores prácticas

  • Documenta comportamiento e intención, no detalles de implementación - enfócate en lo que hace el código, no cómo
  • Incluye tanto ejemplos de camino feliz como escenarios de manejo de errores para cobertura completa
  • Usa terminología consistente en toda la documentación - crea y sigue un glosario

Evitar

  • Escribir ejemplos que omiten manejo de errores - siempre muestra cómo manejar fallos
  • Usar jerga específica de implementación en lugar de lenguaje claro y enfocado en el usuario
  • Crear documentación sin marcadores de versión - siempre indica a qué versión aplica cada característica

Preguntas frecuentes

¿Qué tipos de documentación puede generar esta habilidad?
Esta habilidad genera referencias API, guías de configuración, documentación de esquemas, guías de solución de problemas, guías de migración y referencias completas de módulos. Cubre cualquier documentación técnica que requiera listados exhaustivos de parámetros y formato estructurado.
¿Necesito proporcionar código fuente para la documentación?
Sí, esta habilidad requiere que proporciones el código fuente, especificaciones API o definiciones de esquema que deseas documentar. No puede extraer automáticamente documentación de tu código base - debes proporcionar los materiales a documentar.
¿Qué tan precisa es la documentación generada?
La precisión de la documentación depende de la completitud de tus materiales fuente. Siempre verifica la documentación generada contra implementaciones reales, especialmente para APIs críticas o guías de configuración usadas en producción.
¿Puede esta habilidad documentar múltiples lenguajes de programación?
Sí, la habilidad es independiente del lenguaje y puede documentar APIs, configuraciones y esquemas sin importar el lenguaje de programación. Se enfoca en documentación de interfaz en lugar de detalles de implementación específicos del lenguaje.
¿Soporta esta habilidad especificaciones OpenAPI o Swagger?
La habilidad puede incorporar especificaciones OpenAPI como material fuente y puede generar documentación en un formato compatible con convenciones OpenAPI. Sin embargo, no analiza automáticamente archivos OpenAPI - debes proporcionar los detalles relevantes de la especificación.
¿Cómo debo manejar la documentación para características obsoletas?
Incluye una sección Deprecated para cada característica obsoleta, especificando la versión cuando fue obsoleta, la alternativa recomendada y un cronograma de migración. La habilidad formateará estos según el formato de entrada estándar con guías de migración claras.

Detalles del desarrollador

Autor

sickn33

Licencia

MIT

Repositorio

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/reference-builder

Ref.

main

Estructura de archivos

📄 SKILL.md