IntermedioDocumentaciónAberto

Generador de Documentación Técnica para Funciones de Código

Crea documentación técnica completa con JSDoc o docstrings para funciones y clases.

programaciondocumentacion

Objetivo del Prompt

Documentar 10 funciones en menos de 15 minutos con descripciones, parámetros, retornos y ejemplos de uso.

Ejemplo Real de Uso

TechStart Solutions, startup fintech en México, necesita documentar su API de pagos desarrollada en Node.js. Su equipo de 5 desarrolladores debe entregar documentación técnica para auditoría de seguridad en 48 horas. Con este prompt, documentan las 47 funciones del módulo de transacciones automáticamente.

Prompt

Eres un experto técnico en documentación de software con 15 años de experiencia en código limpio y legible. Tu especialidad es crear documentación profesional que cumpla con estándares de la industria.

CONTEXTO: Necesito que documentes código fuente para que cualquier desarrollador pueda entender, usar y mantener las funciones sin necesidad de consultar al autor original.

OBJETIVO: Generar documentación técnica completa, clara y útil siguiendo las mejores prácticas de documentación de código.

INSTRUCCIONES:
1. Analiza el código proporcionado completamente
2. Identifica la funcionalidad principal de cada función/método/clase
3. Documenta todos los parámetros con tipos de datos y propósito
4. Especifica el valor de retorno y su significado
5. Incluye ejemplos de uso prácticos y realistas
6. Añade posibles excepciones o errores que pueden ocurrir
7. Indica la complejidad temporal y espacial si es relevante
8. Relaciona con otras funciones del módulo cuando aplique

FORMATO DE SALIDA:
Para cada elemento documentado, proporciona:
- Nombre y firma de la función
- Descripción en una línea del propósito principal
- Descripción detallada del funcionamiento
- Tabla de parámetros: nombre | tipo | requerido | descripción
- Valor de retorno: tipo y significado
- Ejemplos de código funcional y comentado
- Posibles excepciones o errores
- Notas adicionales o consideraciones de uso
- Etiquetas de categoría (private/public/internal)

CÓDIGO A DOCUMENTAR:
[PEGAR CÓDIGO FUENTE AQUÍ]

IDIOMA DE DOCUMENTACIÓN: [ESPañol/English]

FORMATO DE DOCSTRING: [JSDoc/numpy-style/reStructuredText/Doxygen/autodetectar]

IMPORTANCIA: Asegúrate de que la documentación sea autocontenida, es decir, que un desarrollador que nunca ha visto este código pueda entenderlo completamente y reutilizarlo sin ayuda externa.

Abrir directamente en una IA (el texto va pre-rellenado):

Cómo usar este prompt

  1. 1Pega el prompt directamente en ChatGPT, Claude, Gemini o cualquier asistente de IA.
  2. 2Personaliza los campos entre corchetes [así] con tu información específica.
  3. 3Para mejores resultados, proporciona contexto adicional sobre tu caso de uso.
  4. 4Combina múltiples prompts en una conversación para resultados más completos.
  5. 5Guarda los prompts que más usas para acceso rápido en el futuro.

Prompts relacionados

Ver todos

Suscríbete a AIClases para desbloquear

Accede a 10.000+ prompts listos para usar en cualquier profesión, además de todos los cursos de la plataforma.

Suscribirse por $10 USD/mes

Cancela cuando quieras. Sin penalidades.