> 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-pt-br/codigo/ferramentas-de-codigo/usando-o-documentador-de-codigo-de-ia.md).
# Usando o documentador de código de IA
{% hint style="warning" %}
#### Escrito para a interface antiga
Este artigo foi escrito para a interface antiga. As instruções ainda podem ser usadas, mas as capturas de tela estão desatualizadas. Em alguns casos, os itens referenciados nas instruções foram movidos ou alterados. Se você não conseguir encontrar um item, consulte o [Para onde foi](/devops/devops-pt-br/transicao-para-a-nova-ui-ux/para-onde-foi.md) artigo.
{% endhint %}
##  Visão geral
Este artigo explica como usar o AI Code Documenter para gerar automaticamente documentação de um componente selecionado. Ele ajuda as equipes a criar documentação de código clara e bem estruturada, que você pode fazer commit na branch.
{% hint style="info" %}
#### Limitações padrão da IA
Por padrão, a Flosum fornece um modelo de IA DeepSeek compartilhado e gratuito para DevOps por meio da API da DeepSeek. Como ele é compartilhado entre tenants, o desempenho e a disponibilidade dependem da carga do sistema e da capacidade de tokens. Durante o uso intenso, você pode ver maior latência ou erros temporários. Para evitar isso, você pode adicionar seu próprio modelo de IA personalizado. Veja o artigo a seguir.
* [Adicionando um modelo de IA personalizado](/devops/devops-pt-br/configuracoes/configuracoes-de-ia/adicionando-um-modelo-de-ia-personalizado.md)
{% endhint %}
{% hint style="info" %}
#### Melhores práticas
* Execute o AI Code Documenter em código estável para evitar regenerar comentários repetidamente.
* Revise sempre os comentários da IA antes de fazer commit para garantir precisão e terminologia correta.
* Faça commit em pequenos blocos lógicos para manter a revisão e o rollback simples.
{% endhint %}
## Usando o AI Code Documenter
{% stepper %}
{% step %}
### Selecione uma branch e um componente
1. Clique em **Código** no menu da barra lateral esquerda.
2. Clique na branch que contém o componente que você deseja documentar.
3. Clique no componente que você deseja documentar.
{% endstep %}
{% step %}
### Criar documentação
1. Clique em **Ferramentas de IA** ao lado de **Editar**.
2. Clique em **AI Code Documenter** no menu suspenso.
3. Enquanto a documentação está sendo gerada, **A IA está gerando...** é exibido.
4. Quando o AI Code Documenter terminar, a visualização das diferenças se abre, com o original à esquerda e as alterações da IA à direita.
5. Revise as alterações e faça as edições necessárias.
6. Clique em **Fazer commit das alterações**.
7. Insira uma **mensagem de commit**.
8. Clique em **Fazer commit**.
{% 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-pt-br/codigo/ferramentas-de-codigo/usando-o-documentador-de-codigo-de-ia.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.
