> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexxible.com/llms.txt
> Use this file to discover all available pages before exploring further.

# O que escrever na base de conhecimento

> Qual conhecimento é útil para as pessoas e os agentes, o que convém deixar de fora e como redigir páginas que sejam bem encontradas e aplicadas.

Uma base de conhecimento é útil quando contém o que não se pode saber de outra forma. Esta página resume o que convém documentar, o que é melhor deixar de fora e como os agentes interpretam o que você escreve.

## O que documentar

Documente o que um modelo de IA, ou uma pessoa recém-chegada, não pode saber sobre a sua organização:

| Tipo de conhecimento | Exemplos |
| - | - |
| Como o ambiente está montado | Qual cliente de VPN é usado e de onde ele é instalado, quais redes Wi-Fi existem, como se chamam os grupos de licenças. |
| Normas locais | "Nunca apague o OST das caixas de correio compartilhadas", "pergunte antes de mexer no notebook de um diretor". |
| Responsáveis e escalonamento | Quem é responsável por cada sistema, para quem se escala e em qual horário. |
| Particularidades conhecidas | A impressora de um escritório que só funciona com um driver específico, um aplicativo que precisa de permissões especiais. |
| Soluções próprias da sua organização | A correção para o seu cliente de VPN, o seu proxy ou as suas GPOs. |

## O que deixar de fora

* **Solução de problemas genérica.** Limpar o cache de DNS ou o significado geral de um código de erro já é conhecido por qualquer modelo. As páginas que repetem isso dificultam encontrar o que é realmente próprio da sua organização.
* **O que está acontecendo agora.** Um incidente em andamento, como "desde a atualização de outubro o Outlook trava em onze notebooks de Madri", não é uma página: fica desatualizado em horas. Os agentes obtêm o estado atual dos dispositivos a partir dos dados em tempo real da plataforma.
* **Senhas, chaves e outros segredos.** Guarde-os no [Cofre](https://docs.flexxible.com/pt-BR/features/flexxible-kb/vault.md) e vincule-os a partir da página.

> [!WARNING]
>
> Não escreva senhas nem chaves no texto de uma página. O editor avisa quando o que você cola parece um segredo e oferece guardá-lo no Cofre.

## Como os agentes interpretam uma página

Os agentes do Flexxible Assist leem a base de conhecimento como um conjunto de fatos e normas, não como um roteiro a ser executado às cegas:

* **As normas são obrigatórias.** Se uma página diz que algo não deve ser feito, o agente respeita isso mesmo que o seu próprio diagnóstico aponte em outra direção.
* **As soluções são indicações.** O agente as compara com o que observa no dispositivo. Se a solução não se encaixar no que ele vê, ele segue o que vê e informa que a página não estava correta.
* **O que falta é notificado.** Quando a base de conhecimento não tem o que precisavam, ou tem de forma errada, os agentes notificam em [Falta na KB](https://docs.flexxible.com/pt-BR/features/flexxible-kb/gaps.md). Eles não criam nem reescrevem páginas por conta própria.

Por isso, convém distinguir no texto o que é uma norma ("nunca", "sempre", "antes de…") do que é um procedimento que funcionou.

## Como redigir uma página útil

| Prática | Por que ajuda |
| - | - |
| Um tema por página | A busca retorna a página e a seção que respondem. Uma página que mistura temas responde pior a todos. |
| Títulos e cabeçalhos descritivos | As pessoas e os agentes chegam diretamente à seção de que precisam. |
| Sintomas tal como um usuário os descreveria | Facilita relacionar a página com o incidente real, também em outros idiomas. |
| Nomes e versões exatos | "GlobalProtect 6.3.1 a partir do Company Portal" pode ser verificado; "o cliente de VPN", não. |
| Passos numerados e resultado esperado | Permite verificar se o procedimento funcionou. |
| Quando escalar e para quem | Indica em que ponto uma pessoa deve intervir. |
| Páginas dentro de páginas | Um escritório com as suas impressoras dentro, ou um sistema com os seus procedimentos, deixa claro a que cada página se aplica. |

Cada página mostra abaixo do título um resumo de uma ou duas frases, **Em resumo**, que o Teammate escreve a partir do conteúdo e atualiza após cada alteração. As pessoas e os agentes também o recebem nos resultados de busca. Se o resumo não refletir o que é importante, melhore a página: o resumo se corrige sozinho.

## Manter a base de conhecimento atualizada

* **Corrija na hora.** Quando um procedimento mudar, edite a página ou diga ao [Teammate](https://docs.flexxible.com/pt-BR/features/flexxible-kb/teammate.md): "O cliente de VPN agora é o GlobalProtect 6.4.0".
* **Revise Falta na KB.** Reúne o que os agentes precisaram e não encontraram, ordenado por relevância.
* **Consulte o uso de cada página.** Cada página mostra quanto foi usada por pessoas e agentes nos últimos 30 dias e quantas das sessões que a usaram foram resolvidas sem escalonamento. Consulte [Uso de uma página](https://docs.flexxible.com/pt-BR/features/flexxible-kb/pages.md#uso-de-una-página).
* **Exclua o que não se aplica mais.** Uma página obsoleta que convive com outra mais recente gera instruções contraditórias. Uma página excluída pode ser restaurada.

Se a sua organização precisar deixar registrado qual versão de uma página foi verificada, pode ativar a [validação de páginas](https://docs.flexxible.com/pt-BR/features/flexxible-kb/validation.md). Para saber quais páginas não estão sendo úteis para quem as lê, pode ativar as [avaliações](https://docs.flexxible.com/pt-BR/features/flexxible-kb/ratings-reactions.md).

## Próximos passos

* [Escrever e editar páginas](https://docs.flexxible.com/pt-BR/features/flexxible-kb/editor.md)
* [Falta na KB](https://docs.flexxible.com/pt-BR/features/flexxible-kb/gaps.md)
* [Agentes do Flexxible Assist](https://docs.flexxible.com/pt-BR/features/flexxible-kb/assist-agents.md)
