Pon al día la documentación del proyecto

Concilia las guías entre sí y con el código, y entrega revisiones coordinadas.

Pon al día la documentación del proyecto

Concilia las guías entre sí y con el código, y entrega revisiones coordinadas.

Escrito por whenreset · Referencias de OpenAI · Fuentes comprobadas:

Referencias y qué se tomó de ellas

  • Mantener la documentación al día

    Toma como referencia la verificación contra el código y fuentes fiables; el mapa de documentación, la coherencia entre documentos y el alcance de una sola pasada son aportes de whenreset.

Prompt completo
Pon al día la documentación de todo este proyecto y resuelve las incoherencias entre documentos y entre la documentación y la implementación. Entrega revisiones utilizables, no solo una lista de auditoría.

Empieza por el README raíz, los índices de documentación y los directorios de docs existentes. Haz un mapa de las guías actuales, el material de referencia, los registros históricos y el contenido generado. Identifica las rutas principales para ejecutar, configurar, desplegar y diagnosticar el proyecto sin pedirme que seleccione archivos. Sigue los documentos relacionados y las definiciones de código fuente, configuración o scripts necesarias para verificarlos. No limites la tarea a un solo documento ni trates afirmaciones históricas como hechos actuales.

Comprueba comandos, nombres de configuración, rutas y procedimientos en conflicto; requisitos previos ausentes; puntos de entrada a guías que falten; y enlaces locales rotos. Da preferencia a la implementación real y a fuentes primarias verificables. Una fecha más reciente no demuestra que algo sea correcto. Etiqueta como no verificados los enlaces externos inaccesibles. No ejecutes comandos de instalación, despliegue, modificación de datos ni borrado para verificar.

Da prioridad a los errores que provocan operaciones fallidas o una comprensión equivocada. Cuando un problema abarque varios documentos, propón revisiones coherentes en todos los pasajes afectados. Aporta ubicaciones, afirmaciones originales, evidencia e impacto práctico, seguidos de pasajes de reemplazo completos o de un parche aplicable. Un documento corto puede recibir una revisión completa. Evita las reescrituras cosméticas, conserva los hechos inciertos y no presentes como disponibles capacidades sin terminar o sin aceptar.

Si el corpus es grande, cubre primero las rutas de uso principales y los documentos en conflicto, y luego enumera de forma explícita las áreas sin examinar. No te detengas en un número arbitrario de documentos ni afirmes una cobertura exhaustiva. Coteja una vez las revisiones, las rutas y los nombres de comandos; después entrega el mapa de documentación, las revisiones completadas y los elementos sin verificar, y detente.

Contrato de ejecución:
Empieza directamente. No me pidas que apruebe un plan, que elija archivos ni que rellene una plantilla. Usa solo este proyecto, esta conversación y los materiales ya proporcionados; no busques en proyectos ajenos ni en historial privado. Completa lo que la evidencia respalde e informa de los datos que falten. Si la tarea no es aplicable, explica por qué y detente sin inventar un resultado.
Conserva los archivos existentes y los cambios sin confirmar (uncommitted). Incluye el contenido propuesto completo en tu respuesta; los entregables independientes pueden guardarse con un nombre de archivo nuevo que no esté en uso. No instales dependencias, no cambies el entorno y no hagas commit, push ni despliegues. Respeta los límites de acceso y de permisos e informa del trabajo bloqueado. Revisa tu resultado una vez, entrégalo y detente sin preguntar si debes continuar.