Amendary: sincronización de documentación con código mediante IA

Fuentes: Amendary: syncing documentation with code using AI

La sincronización de la documentación técnica con el código fuente sigue siendo un desafío crítico en el desarrollo de software, a pesar de la disponibilidad de modelos de lenguaje de gran escala (LLM). El autor, George Petropoulos, argumenta que la generación automática de texto no resuelve la complejidad de mantener la coherencia entre múltiples fuentes de verdad, como READMEs, guías de despliegue y documentación de clientes en plataformas como Notion. Un solo cambio en el código, como la modificación de un tiempo de espera, puede requerir correcciones distintas según el contexto de cada documento: la referencia de ingeniería necesita la actualización inmediata, mientras que las guías de cliente deben esperar a la versión estable y los informes históricos deben conservar los valores pasados. La herramienta Amendary aborda este problema mediante un enfoque de mapeo explícito. Los usuarios conectan su repositorio de código con las fuentes de documentación existentes, definiendo qué páginas deben monitorearse y a qué repositorios se asocian. Amendary compara los cambios en el código con la documentación actual para identificar discrepancias válidas. En lugar de generar correcciones ciegas, el sistema presenta un borrador con la evidencia original y la corrección propuesta, permitiendo a los desarrolladores revisar y validar el cambio antes de aplicarlo. Este proceso reduce la carga de trabajo manual y minimiza el riesgo de introducir errores en la documentación pública, asegurando que las correcciones sean precisas y contextualmente correctas.