La documentación para desarrolladores normalmente incluye una descripción en cada archivo. Estas descripciones pueden quedar obsoletas, generando confusión e información incorrecta. Para evitar esto, puedes automatizar la detección de descripciones obsoletas en tu documentación usando un poco de IA y GenAIScript.
Muchos sistemas de documentación utilizan el formato Markdown para escribir documentación y un encabezado 'frontmatter' para almacenar metadatos. Aquí hay un ejemplo de un archivo de rebajas con frontmatter:
--- title: "My Document" description: "This is a sample document." --- # My Document Lorem ipsum dolor sit amet, consectetur adipiscing elit.
El objetivo es crear un script que detecte cuando el campo de descripción en el frontmatter está desactualizado.
GenAIScript está diseñado para ejecutarse en archivos y proporciona una variable especial env.files que contiene la lista de archivos que se analizarán. Puede usar esta variable para incluir los archivos en el contexto usando la función def. Limitamos cada archivo a 2000 tokens para evitar que el contenido explote en archivos grandes.
// Define the file to be analyzed def("DOCS", env.files, { endsWith: ".md", maxTokens: 2000 })
El siguiente paso es asignar una tarea al guión. En este caso, verificar que el campo de contenido y descripción en el frontmatter coincidan.
// Analyze the content to detect outdated descriptions $`Check if the 'description' field in the front matter in DOCS is outdated.`
Finalmente, aprovechamos la función de generación de diagnóstico incorporada para crear un error para cada descripción desactualizada.
// enable diagnostics generation $`Generate an error for each outdated description.`
Una vez que guardes este script en tu espacio de trabajo, podrás ejecutarlo en un archivo o carpeta a través del menú contextual
seleccionando Ejecutar GenAIScript....
Puedes ejecutar automáticamente esta herramienta en tus archivos de documentación para identificar descripciones obsoletas usando la CLI.
npx --yes genaiscript run detect-outdated-descriptions **/*.md
Este script se puede integrar en su proceso de CI/CD para automatizar el proceso de detección.
Descargo de responsabilidad: Todos los recursos proporcionados provienen en parte de Internet. Si existe alguna infracción de sus derechos de autor u otros derechos e intereses, explique los motivos detallados y proporcione pruebas de los derechos de autor o derechos e intereses y luego envíelos al correo electrónico: [email protected]. Lo manejaremos por usted lo antes posible.
Copyright© 2022 湘ICP备2022001581号-3