MOVERE Software

Objetivo das Perguntas e Respostas

Orientar de forma rápida e direta como resolver questões simples, que não dependam de configurações excessivas e ativação de processos complexos.

Segue abaixo os critérios adotados para escrever uma base de conhecimento no formato de [Pergunta e Resposta].

Quando utilizar Pergunta/Resposta

• Quando o suporte abrir um ticket de pergunta/resposta;
• Para o caso de dúvidas recorrentes;
• Para o caso de PBIs que modificam pequenas partes de um processo.
  Ex: Criar um campo em um relatório;
• Para o caso em que não existe uma BC oficial sobre aquele assunto e o time julgue desnecessário criar uma BC completa para explicar o que foi feito;

O que uma Pergunta e resposta deve ter?

• A pergunta deve estar bastante específica e clara;
• A resposta deve ser breve. Maiores detalhes estarão na documentação oficial do processo/rotina;

O que uma Pergunta e resposta não deve ter?

• Muitos detalhes;

Regras para escrita do título [ Pergunta ]

• Sempre iniciar o título com [FAQ], seguido de espaço e da pergunta;
• Não duplicar o título no corpo da Pergunta e Resposta;
• A pergunta precisa ser sucinta;
• Se necessário mencionar alguma rotina, utilizar o padrão RXXX;
• Se necessário mencionar algum parâmetro, utilizar o padrão PXXX.
• O nome da rotina NÃO deve ser mencionado no título, apenas o código da rotina.

Regras para a escrita do Corpo [ Resposta ]

• A primeira vez que uma rotina for mencionada, o código e o nome da rotina devem ser mencionados no formato rotina [RXXX - Nome Da Rotina]. Se a rotina for mencionada novamente no documento, então o nome dela deve ser omitida, por exemplo:

• Ao mencionar parâmetros, utilizar a mesma regra para menção das rotinas, porém com o formato parâmetro [PXXX – Nome do Parâmetro].
• Quando se tratar de um relatório, deve ser mencionado que se trata de um relatório, e não de uma rotina. Exemplo:
  1. “Emitir o relatório [R112 - ...” [correto]
  2. “Emitir a partir da rotina [R112 - ...” [errado]
• Ao final de cada pergunta e resposta, se possível, conectar à B.C. do processo completo, no formato utilizado pela rotina [R878 - Documentação do Versionamento de Rotina]:

Para maiores informações, clique aqui.

• Proibido utilizar termos do contexto de desenvolvimento de software [ Checkbox, dropdown, label ]. Uma alternativa, nesse caso, é utilizar “campo”, por exemplo;
• A maioria dos clientes não são bilíngues, então termos em outras línguas devem evitados;

Preenchimento das Tags das Bases de Conhecimento

• Mencionar o número das rotinas/relatórios envolvidas [R1, R11, R657, R400];
• Mencionar o número dos parâmetros envolvidos [P1, P34, P234]

Segue um exemplo de pergunta e resposta dentro dos padrões.