How to Mantén la documentación actualizada with Eigent

Cómo funciona

1. Comparte los archivos de origen modificados, la rama, el pull request o el commit que necesita documentarse.
2. Pídele a Eigent que busque en la documentación existente los nombres de funciones, claves de configuración, comandos y ejemplos que se ven afectados.
3. Actualiza solo la documentación que necesite cambiar: conserva la estructura de la página, la terminología, los enlaces cruzados y el frontmatter.
4. Ejecuta las comprobaciones de formato y de documentación, y luego pide a Eigent que resuma la evidencia detrás de cada afirmación visible para el usuario.
5. Revisa el resumen antes de publicar para confirmar que no se filtró ningún contexto interno o no publicado en la documentación pública.

Más prompts para probar

• ¿Qué páginas de documentación existentes hacen referencia al comportamiento cambiado en este PR?
• ¿Este cambio afecta a algún parámetro de API pública, valor predeterminado o flag de CLI que deba actualizarse?
• Escribe una entrada de changelog para este lanzamiento que coincida con nuestro formato existente.
• Identifica cualquier afirmación visible para el usuario en la documentación actualizada que no puedas verificar solo con el código fuente.

Cómo usar

Empieza por el cambio que necesitas documentar: comparte la rama, el PR o el commit. Pídele a Eigent que busque en la documentación existente antes de redactar cualquier cosa, para que actualice las páginas correctas en lugar de escribir nuevas que dupliquen contenido existente. Mantén el alcance reducido: una nota o un ejemplo precisos son mejores que una reescritura completa de la página. Para que esto sea repetible, guarda el flujo de trabajo como una skill o pide a Eigent que lo ejecute según un horario después de cada lanzamiento.

Resultado esperado

Archivos de documentación actualizados que cubran solo los cambios visibles para el usuario, un resumen de lo que se cambió y verificó, y una lista de cualquier afirmación que no se pudo confirmar con fuentes confiables y que requiera revisión humana.

Limitaciones

• Eigent no puede acceder a datos privados de clientes, elementos no publicados de la hoja de ruta ni wikis internas a menos que se los proporciones explícitamente.
• La precisión de la documentación depende de la calidad de los comentarios del código y de la cobertura de pruebas: el comportamiento no documentado puede pasarse por alto.
• Los sitios de documentación muy grandes se benefician de limitar la búsqueda a una sección o área de funcionalidad específica en lugar de todo el sitio.