Generador de Documentacion

El Problema

La documentacion es lo primero que se sacrifica cuando los plazos aprietan. Las funciones quedan sin documentar, los READMEs se vuelven obsoletos, y los nuevos miembros del equipo pasan dias haciendo ingenieria inversa del codigo. Escribir documentacion desde cero es lento, pero la IA puede analizar tu codigo y generar documentacion precisa en segundos.

El Prompt

Eres un experto en documentacion tecnica. Genera documentacion integral para el siguiente codigo:

CODIGO:
[pega tu funcion, clase, modulo o endpoint de API aqui]

LENGUAJE: [ej. TypeScript, Python, Go]
FORMATO DE DOCS: [ej. JSDoc, Python docstring, GoDoc]

Genera:
1. **Documentacion Inline**: JSDoc/docstring completo con @param, @returns, @throws, @example
2. **Seccion de README**: Seccion Markdown explicando que hace el codigo, cuando usarlo, y un ejemplo rapido
3. **Ejemplos de Uso**: 3 ejemplos practicos cubriendo uso basico, caso especial y manejo de errores
4. **Firmas de Tipo**: Si no esta tipado, sugiere la firma de tipo completa

Manten las descripciones concisas pero precisas. Prefiere ejemplos concretos sobre explicaciones abstractas.

Ejemplo de Salida

/**
 * Reintenta una operacion asincrona con backoff exponencial.
 *
 * @param fn - La funcion asincrona a reintentar
 * @param options - Configuracion del comportamiento de reintento
 * @param options.maxRetries - Numero maximo de intentos (defecto: 3)
 * @param options.baseDelay - Retraso inicial en ms (defecto: 1000)
 * @param options.maxDelay - Tope maximo de retraso en ms (defecto: 30000)
 * @returns El valor resuelto de fn
 * @throws El ultimo error despues de agotar todos los reintentos
 *
 * @example
 * const data = await retry(() => fetch('/api/users'), { maxRetries: 5 });
 */

Cuando Usar

Usa este skill cuando termines de escribir una funcion, modulo o endpoint de API y necesites documentarlo antes de continuar. Tambien es poderoso para generar documentacion de codigo legacy que estes revisando o recibiendo de otro equipo.

Tips Pro

• Pega el archivo completo, no solo una funcion — la IA genera mejor documentacion cuando entiende el contexto circundante y como las funciones se relacionan entre si.
• Especifica la guia de estilo de tu equipo — agrega “Sigue el Google TypeScript Style Guide” o “Usa el formato de docstring NumPy” para coincidir con tus convenciones existentes.
• Genera tambien una entrada de changelog — agrega “Tambien escribe una entrada de CHANGELOG.md para este cambio” para producir notas de release junto con la documentacion.