Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Para mejorar los resultados de la generación de documentación con Amazon Q, siga estas prácticas recomendadas:
-
Amazon Q puede generar documentación para cualquier cantidad de código dentro de la cuota de tamaño del proyecto de código; sin embargo, los repositorios muy grandes tardarán más en generar documentación y pueden ser menos específicos. Si tiene un repositorio grande, considere la posibilidad de solicitar documentación para un subconjunto de código o un solo archivo para obtener resultados más específicos.
-
La calidad de la documentación que genera Amazon Q puede mejorarse si el código está bien comentado y organizado, tiene buenas convenciones de nomenclatura para las entidades de programación y sigue otras convenciones de codificación estándar.
-
Amazon Q produce documentación de la más alta calidad para el código escrito en uno o varios de los idiomas admitidos. Es posible que el código escrito en otros idiomas no se refleje en la documentación generada o que produzca una documentación de menor calidad. Para obtener más información sobre los idiomas, consulteSoporte de lenguaje para la generación de documentación con /doc.
-
Si desea solicitar cambios específicos en un archivo README en lenguaje natural, puede hacerlo si decide actualizar un archivo README existente y, a continuación, elige la opción de realizar un cambio específico. Una vez que Amazon Q genere la documentación, también puedes optar por realizar cambios y describir las actualizaciones que deseas que realice Amazon Q.
-
Cuando describas las actualizaciones que deseas que Amazon Q introduzca en la documentación, ten en cuenta lo siguiente:
-
La descripción de los cambios debe incluir las secciones que desee modificar, el contenido que desee añadir o eliminar y los problemas específicos que deban corregirse.
-
Los cambios deben estar relacionados con la forma en que se refleja la funcionalidad del proyecto en el archivo README.
-
El contenido al que hagas referencia debe estar disponible en tu base de código.
-
-
Amazon Q no tiene acceso a plataformas privadas o internas. Es posible que Amazon Q tampoco tenga conocimiento de herramientas o software de terceros o de herramientas especializadas en su código. Si tu código incluye recursos a los que Amazon Q no puede acceder o con los que no está familiarizado, ese código no se documentará. Puedes editar manualmente el archivo README para incluir contenido que Amazon Q no puede generar.
