Generador de Documentación Técnica con JSDoc
Crea documentación profesional en español para funciones JavaScript usando el estándar JSDoc.
Objetivo del Prompt
Documentar una función completa con descripción, parámetros, retornos y ejemplos de uso en menos de 2 minutos
Ejemplo Real de Uso
TechStart es una startup colombiana de desarrollo web con 8 programadores. Su equipo necesita documentar 45 funciones del módulo de autenticación para un cliente bancario que requiere handover técnico. Sin documentación, el onboarding de nuevos desarrolladores toma 3 semanas.
Prompt
Eres un desarrollador senior con 10 años de experiencia en JavaScript y metodologías ágiles. Tu tarea es generar documentación técnica profesional.
[CONTEXTO]
Eres el responsable de documentación en un equipo de desarrollo. Necesitas crear documentación clara y útil para otros programadores.
[INSTRUCCIONES]
1. Analiza la función proporcionada
2. Identifica: propósito, parámetros, tipos de datos, valor de retorno y posibles excepciones
3. Genera documentación JSDoc completa en español
4. Incluye ejemplos de uso prácticos
5. Señala dependencias o consideraciones especiales
[FORMATO DE SALIDA]
/**
* @description [descripción clara del propósito]
* @author [nombre del autor]
* @date [fecha actual]
* @param {tipo} [nombre] - [descripción]
* @returns {tipo} [descripción del retorno]
* @throws {tipo} [descripción del error]
* @example
* // [caso de uso básico]
* // [caso de uso avanzado]
*/
[CÓDIGO A DOCUMENTAR]
[Pega aquí el código JavaScript que necesita documentación]
[REQUISITOS ADICIONALES]
- Lenguaje: español profesional técnico
- Nivel de detalle: exhaustivo
- Incluir notas de rendimiento si aplicaAbrir directamente en una IA (el texto va pre-rellenado):
Cómo usar este prompt
- 1Pega el prompt directamente en ChatGPT, Claude, Gemini o cualquier asistente de IA.
- 2Personaliza los campos entre corchetes [así] con tu información específica.
- 3Para mejores resultados, proporciona contexto adicional sobre tu caso de uso.
- 4Combina múltiples prompts en una conversación para resultados más completos.
- 5Guarda los prompts que más usas para acceso rápido en el futuro.
Prompts relacionados
Ver todosGenerador de Documentación API REST Completa con Ejemplos de Código
Crea documentación técnica profesional para APIs REST con endpoints, parámetros, respuestas y ejemplos de código.
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.
Generador de Documentación Técnica Completa para APIs y Código
Crea documentación técnica profesional con ejemplos, casos de uso y guías de implementación listas para usar.
Generador de Documentación Técnica de Código Fuente
Crea documentación profesional para funciones, módulos o componentes de código con descripción, parámetros, retorno, eje
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.
Cancela cuando quieras. Sin penalidades.