> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/devops/devops-es/codigo/herramientas-de-codigo/uso-de-ai-code-documenter.md).
# Uso de AI Code Documenter
{% hint style="warning" %}
#### Escrito para la antigua interfaz de usuario
Este artículo fue escrito para la antigua interfaz de usuario. Las instrucciones todavía se pueden usar, pero las capturas de pantalla están desactualizadas. En algunos casos, los elementos mencionados en las instrucciones se han movido o cambiado. Si no puede encontrar un elemento, consulte el [¿Dónde quedó?](/devops/devops-es/transicion-a-la-nueva-ui-ux/donde-quedo.md) artículo.
{% endhint %}
##  Resumen
Este artículo explica cómo usar AI Code Documenter para generar automáticamente documentación para un componente seleccionado. Ayuda a los equipos a crear documentación de código clara y bien estructurada que puedes confirmar en la rama.
{% hint style="info" %}
#### Limitaciones predeterminadas de la IA
De forma predeterminada, Flosum proporciona un modelo de IA DeepSeek compartido gratuito para DevOps a través de la API de DeepSeek. Debido a que se comparte entre inquilinos, el rendimiento y la disponibilidad dependen de la carga del sistema y de la capacidad de tokens. Durante un uso intensivo, es posible que vea una mayor latencia o errores temporales. Para evitar esto, puede agregar su propio modelo de IA personalizado. Consulte el siguiente artículo.
* [Agregar un modelo de IA personalizado](/devops/devops-es/configuracion/configuracion-de-ia/agregar-un-modelo-de-ia-personalizado.md)
{% endhint %}
{% hint style="info" %}
#### Buenas prácticas
* Ejecuta AI Code Documenter sobre código estable para evitar regenerar comentarios repetidamente.
* Revisa siempre los comentarios de IA antes de confirmar para garantizar la precisión y la terminología correcta.
* Confirma en fragmentos pequeños y lógicos para mantener sencilla la revisión y la reversión.
{% endhint %}
## Uso de AI Code Documenter
{% stepper %}
{% step %}
### Seleccione una rama y un componente
1. Haz clic en **Código** desde el menú de la barra lateral izquierda.
2. Haz clic en la rama que contiene el componente que quieres documentar.
3. Haz clic en el componente que quieres documentar.
{% endstep %}
{% step %}
### Crear documentación
1. Haz clic en **Herramientas de IA** junto a **Editar**.
2. Haz clic en **AI Code Documenter** en el menú desplegable.
3. Mientras se genera la documentación, **La IA está generando...** se muestra.
4. Cuando AI Code Documenter termina, se abre el visor de diferencias, con el original a la izquierda y los cambios de IA a la derecha.
5. Revisa los cambios y realiza cualquier edición necesaria.
6. Haz clic en **Confirmar cambios**.
7. Introduce un **mensaje de commit**.
8. Haz clic en **Confirmar**.
{% endstep %}
{% endstepper %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.flosum.com/devops/devops-es/codigo/herramientas-de-codigo/uso-de-ai-code-documenter.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
