Codex use case
Mantén la documentación al día
Usa el código y otras fuentes para automatizar la actualización de la documentación.
Usa Codex para comparar los cambios en el código fuente con la documentación pública, las notas de la versión y el contexto de los PR. Luego, pídele que redacte cambios puntuales en la documentación e incluya los pasos para verificarlos antes de publicar.
Best for
- Documentación para desarrolladores, archivos README, guías operativas, ejemplos y notas de migración que deben reflejar cambios frecuentes en el comportamiento del producto.
- Equipos que mantienen la documentación de un producto técnico.
Contents
Mantén la documentación al día
Usa el código y otras fuentes para automatizar la actualización de la documentación.
Usa Codex para comparar los cambios en el código fuente con la documentación pública, las notas de la versión y el contexto de los PR. Luego, pídele que redacte cambios puntuales en la documentación e incluya los pasos para verificarlos antes de publicar.
Usa Codex para comparar los cambios en el código fuente con la documentación pública, las notas de la versión y el contexto de los PR. Luego, pídele que redacte cambios puntuales en la documentación e incluya los pasos para verificarlos antes de publicar.
Related links
Best for
- Documentación para desarrolladores, archivos README, guías operativas, ejemplos y notas de migración que deben reflejar cambios frecuentes en el comportamiento del producto.
- Equipos que mantienen la documentación de un producto técnico.
Skills & Plugins
- Revisa issues, Pull Requests, comentarios, hilos de revisión y comprobaciones fallidas cuando uses GitHub para recibir reportes de errores.
| Skill | Why use it |
|---|---|
| GitHub | Revisa issues, Pull Requests, comentarios, hilos de revisión y comprobaciones fallidas cuando uses GitHub para recibir reportes de errores. |
Starter prompt
Introducción
Es más fácil mantener la documentación al día si la actualizas al mismo tiempo que el código fuente, sin esperar varias semanas. Codex puede revisar los cambios en el código y las pruebas, las notas de la versión, los issues vinculados y el contexto de los pull requests. Con esa información, puede redactar una actualización que se limite a los cambios pertinentes y respete la estructura de la documentación.
Usa este flujo de trabajo para redactar documentación para desarrolladores, actualizar archivos README, preparar borradores de registros de cambios, escribir notas de migración o guías operativas, o mantener al día cualquier otro documento que describa un comportamiento que cambia con frecuencia.
Cómo usar este flujo de trabajo
-
Empieza por el cambio que necesitas documentar.
Comparte la rama, el pull request, el commit, el issue o los archivos. Si la documentación es pública, indica expresamente que debe excluir los planes de desarrollo que aún no se hayan publicado, los datos privados de clientes y la información de uso exclusivamente interno.
-
Pide a Codex que identifique qué partes de la documentación se ven afectadas.
Antes de que empiece a redactar, pídele que busque en la documentación existente los nombres de las funciones, las claves de configuración, los comandos, los ejemplos y los términos relacionados.
-
Actualiza solo la parte de la documentación necesaria para explicar el cambio.
Codex debe conservar la estructura actual de la página, la terminología, los enlaces cruzados y el frontmatter. Debe evitar reescribir grandes partes del texto si basta con una nota precisa, un ejemplo o un ajuste en una sección.
-
Verifica los cambios.
Pide a Codex que ejecute las comprobaciones de formato y documentación que correspondan al repositorio. Luego pídele que resuma qué evidencia respalda cada afirmación dirigida a los usuarios.
Qué compartir con Codex
| Fuente | Por qué es útil |
|---|---|
| Cambios en el código y las pruebas | Permiten que Codex analice el comportamiento real y redacte actualizaciones específicas de la documentación. |
| Notas de la versión o documentación del producto de acceso público | Ayudan a Codex a usar la terminología pública y a reflejar la disponibilidad y el estado de las funciones. |
| Contexto del pull request o del issue | Explica el motivo del cambio y qué comportamiento es relevante para los usuarios. |
| Comprobaciones locales de la documentación | Le indican a Codex qué criterios debe cumplir la documentación para considerarla lista para su publicación. |
Si compartes más contexto, como las notas públicas de la versión, Codex puede evitar incluir información privada o novedades que aún no se han hecho públicas.
Cómo reutilizar el flujo de trabajo
Para establecer una convención en todo el repositorio, agrega las pautas de documentación a AGENTS.md. Por ejemplo:
## Documentación
- Cuando cambie un comportamiento que los usuarios puedan observar, revisa si es necesario actualizar la documentación, los ejemplos o los registros de cambios.
- En la documentación pública, incluye únicamente información pública o descripciones de comportamientos observables en este repositorio.
- Conserva la terminología y el frontmatter existentes.
- Antes de la entrega final, ejecuta las comprobaciones de formato y de compilación de la documentación.Si el proceso tiene más pasos, conviértelo en una habilidad para que Codex pueda seguir el mismo ciclo de revisión de fuentes, redacción y verificación en tareas futuras. Consulta Guardar flujos de trabajo como habilidades para conocer más detalles sobre este método.
También puedes programar una tarea para este flujo de trabajo desde el chat actual. Por ejemplo, pide a Codex que consulte los pull requests recientes de GitHub y mantenga la documentación al día cada semana:
Related use cases
Convierte un issue en un pull request con cambios probados
Dale a Codex un issue de alcance definido, un entorno en la nube ya preparado y una lista...
Crea juegos de navegador
Usa Codex para convertir la descripción de tu juego en un plan bien definido y luego...
Crea una CLI que Codex pueda usar
Pídele a Codex que cree una CLI que pueda ejecutar desde cualquier carpeta, combinar con...