Prompts para documentación técnica
Documentar sin que se convierta en la tarea que siempre se pospone.
Última actualización editorial: 2026-09-26
Documentar una función o módulo de código
Finalidad: Generar documentación técnica a partir de código ya escrito.
Documenta esta función/módulo: {{codigo}}. Incluye: qué hace, parámetros de entrada, qué devuelve, y un ejemplo de uso. Formato {{formato}}.Variables
{{codigo}}— El código a documentar.{{formato}}— Por ejemplo: JSDoc, docstring de Python, Markdown.
Cómo usarlo: Revisa que la documentación generada describa lo que el código REALMENTE hace, no lo que el nombre de la función sugiere — pueden no coincidir.
Ejemplo relleno
Documenta esta función/módulo: [código de una función de validación]. Incluye: qué hace, parámetros de entrada, qué devuelve, y un ejemplo de uso. Formato JSDoc.
Redactar un README para un proyecto
Finalidad: Dar a quien llegue nuevo al proyecto lo que necesita para arrancar.
Redacta un README para un proyecto de {{tipo_de_proyecto}} que hace {{descripcion_funcional}}. Incluye: instalación, cómo ejecutarlo en local, y estructura básica de carpetas: {{estructura}}.Variables
{{tipo_de_proyecto}}— Librería, API, aplicación, etc.{{descripcion_funcional}}— Qué hace el proyecto.{{estructura}}— Carpetas principales, si ya las tienes definidas.
Cómo usarlo: Prueba literalmente los comandos de instalación que proponga antes de publicarlos — un paso que falla en el primer intento desanima a cualquiera que llegue nuevo.
Ejemplo relleno
Redacta un README para un proyecto de API REST que hace gestión de tareas para equipos pequeños. Incluye: instalación, cómo ejecutarlo en local, y estructura básica de carpetas: src/, tests/, docs/.
Guía de instalación paso a paso
Finalidad: Convertir el conocimiento disperso del equipo en una guía reproducible.
Necesito una guía de instalación paso a paso para {{herramienta_o_sistema}}, en {{sistema_operativo}}. Los requisitos previos son: {{requisitos}}. Numera los pasos y usa comandos exactos, no descripciones vagas.Variables
{{herramienta_o_sistema}}— Qué se está instalando.{{sistema_operativo}}— macOS, Windows, Linux.{{requisitos}}— Lo que ya debe estar instalado antes.
Cómo usarlo: Sigue la guía tú mismo en una máquina limpia antes de compartirla — es la única forma de detectar un paso que asume algo que no está explicado.
Ejemplo relleno
Necesito una guía de instalación paso a paso para un entorno de desarrollo con Node.js y PostgreSQL, en macOS. Los requisitos previos son: Homebrew ya instalado. Numera los pasos y usa comandos exactos, no descripciones vagas.
Preguntas frecuentes
¿La documentación generada queda siempre actualizada?
No automáticamente — hay que regenerarla o revisarla cada vez que el código cambie de forma significativa.