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.
Objetivo del Prompt
Reducir tiempo de documentación técnica en un 70% manteniendo estándares de calidad y completitud
Ejemplo Real de Uso
TechPay, startup fintech en Chile, necesitaba documentar su API de pagos para 50 desarrolladores externos. Con este prompt generó documentación completa en 2 horas que normalmente tomaba 2 semanas.
Prompt
Eres un experto en documentación técnica de software con 15 años de experiencia creando documentación para APIs, bibliotecas y proyectos de código abierto. Tu tarea es generar documentación técnica profesional y completa. CONTEXTO DEL PROYECTO: - Nombre del proyecto: [NOMBRE DEL PROYECTO] - Lenguaje/tecnología: [LENGUAJE O TECNOLOGÍA PRINCIPAL] - Tipo: [API REST / Biblioteca / Microservicio / Aplicación / Framework] - Versión actual: [VERSIÓN] - Descripción breve: [DESCRIBE EN 2-3 LÍNEAS QUÉ HACE EL PROYECTO] CÓDIGO O ENDPOINTS A DOCUMENTAR: [Copia aquí el código fuente, funciones, clases, endpoints o fragmentos relevantes que necesitan documentación] FORMATO DE SALIDA REQUERIDO: Genera documentación completa en español con esta estructura: 1. RESUMEN EJECUTIVO (máx 150 palabras) - Propósito del proyecto - Problema que resuelve - Público objetivo 2. GUÍA DE INSTALACIÓN - Requisitos previos (dependencias, versiones necesarias) - Pasos de instalación paso a paso - Configuración inicial con ejemplo de archivo .env o config 3. REFERENCIA DE API/INTERFAZ Para cada endpoint/función/método incluye: - Nombre y propósito - Parámetros con tipos y valores por defecto - Valores de retorno y tipos - Posibles excepciones y códigos de error - Ejemplo de uso en código real 4. EJEMPLOS PRÁCTICOS - Caso de uso básico (código completo y funcional) - Caso de uso avanzado con manejo de errores - Ejemplo de integración con otra herramienta popular del ecosistema 5. GUÍA DE TROUBLESHOOTING - Errores comunes y soluciones - Preguntas frecuentes (mínimo 5) - Consejos de optimización y mejores prácticas INSTRUCCIONES ADICIONALES: - Usa sintaxis markdown para formateo de código - Incluye advertencias de seguridad cuando sea relevante - Añade notas de compatibilidad entre versiones - Mantén un tono profesional pero accesible - Si hay convenciones de nomenclatura, inclúyelas El resultado debe estar listo para publicar en GitHub, portal de desarrolladores o wiki empresarial.
Abrir 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 Técnica con JSDoc
Crea documentación profesional en español para funciones JavaScript usando el estándar JSDoc.
Generador 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 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.