Guia para Otimizar Documentos para Base de Conhecimento da IA

Otimizar um documento para a base de conhecimento de uma IA significa torná-lo fácil de ser lido e compreendido pela máquina. As estruturas a seguir garantem que a IA consiga extrair do Centro de Aprendizagem as informações mais relevantes, evitando, ruídos e redundâncias.


Padrão para Dúvida sobre o Sistema (UCA - Dúvida sobre o Sistema)

Use este padrão para criar conteúdos que respondem a perguntas diretas ou ensinam como fazer algo no sistema.

InformaçãoDescrição
Título

Deve ser simples, direto, específico e descrevendo a ação principal.

    • Exemplo: Como emitir uma Nota Fiscal de Serviço Eletrônica (NFS-e) no Shop?

    • Exemplo: Como emitir uma Nota Fiscal de Serviço Eletrônica (NFS-e) no ERP4ME.One?
    • Exemplo: Como emitir uma Nota Fiscal de Serviço Eletrônica (NFS-e) no Bimer?
Resumo ou Introdução

Esta é a seção mais importante para a IA. Nela, você deve explicar de forma clara e objetiva o que o documento aborda e como ele ajuda o usuário.

    • Exemplo: Este artigo detalha o passo a passo para emitir uma NFS-e no sistema, desde o preenchimento dos dados até a sua emissão final.

Passo a Passo

Crie uma lista numerada para guiar o usuário de forma lógica. Cada passo deve ser uma ação específica.

    • Exemplo:

      1. No menu principal, acesse Vendas > Notas Fiscais.

      2. Clique em Nova NFS-e.

      3. Preencha todos os campos obrigatórios, como Cliente e Serviço.

Descrição das Imagens

Inclua uma breve descrição textual para cada uma das imagens, explicando o que ela mostra. Isso é fundamental para que a IA compreenda o fluxo visual.

Glossário (Incorporado ao Texto)

Em vez de uma seção separada, explique os termos técnicos ou siglas na primeira vez que eles aparecerem.

    • Exemplo: “O Recibo Provisório de Serviços (RPS) será gerado automaticamente após a emissão da nota.”

FAQ - Outras perguntas:Inclua uma seção com perguntas e respostas frequentes sobre o tema. Embora possa ser oculta na página para o usuário, essa informação é valiosa para a IA, que a utilizará para gerar respostas a perguntas correlatas.

 


Padrão para Solução de Problema (UCA - Artigo para Solução de Problema)

Use este modelo para criar artigos que ajudam a resolver um erro ou problema específico.

InformaçãoDescrição
Título

Deve ser simples, direto, específico e descrevendo a ação principal.

    • Exemplo: Como exportar produtos do Shop Simples para balança?

    • Exemplo: Como exportar produtos do Shop para balança?
Resumo ou Introdução

Descreva o problema que o artigo ajudará a resolver e o que o usuário aprenderá com a leitura.

    • Exemplo: Este artigo explica as causas do erro “Código de Serviço não encontrado” e apresenta a solução para corrigi-lo.

Quando o Problema Ocorre

Descreva os cenários que levam ao erro. Essa informação ajuda a IA a entender a causa-raiz do problema.

    • Exemplo: Este erro acontece quando o código do serviço no cadastro não está de acordo com a lista oficial da prefeitura, ou quando o cadastro está incompleto.

Passo a Passo para Resolver

Crie uma lista de ações para guiar o usuário na resolução do problema.

    • Exemplo:

      1. Acesse Configurações > Cadastros > Serviços.

      2. Localize o serviço que está causando o erro.

      3. Atualize o campo Código de Serviço com o valor correto.

Descrição das ImagensInclua uma breve descrição textual para cada uma das imagens, explicando o que ela mostra. Isso é fundamental para que a IA compreenda o fluxo visual.
Glossário (Incorporado ao Texto)Mantenha a mesma regra: defina os termos técnicos na sua primeira aparição.
  • Exemplo: “O Recibo Provisório de Serviços (RPS) será gerado automaticamente após a emissão da nota.”
FAQ - Outras perguntasInclua perguntas e respostas relacionadas ao erro ou a outros problemas que podem surgir durante a solução.