Padrões para Elaboração de Documentos da Base de Conhecimento Sistema de Gestão da Qualidade. Sumário

Instrução de Trabalho - IT V 1.3 Página 1 de 7

Sumário

Instrução de Trabalho - IT V 1.3 Página 2 de 7

1. DEFINIÇÃO

1.1. PROBLEMA/DÚVIDA

Problema representa um resultado indesejável, tal como uma mensagem de erro ou rejeição ou algo que não funciona como o esperado pelo cliente;

Dúvida algo que o cliente não sabe utilizar, podendo ser definido como o sintoma e aquilo que o cliente está tentando fazer e não está conseguindo.

1.2. SOLUÇÃO

Solução é aquilo que resolve/soluciona um problema ou dificuldade, representa a experiência do usuário com o resultado obtido de um evento. No que diz respeito ao ciclo de vida da solução, ela pode ser evoluída e reutilizável.

2. ESTRUTURA DA SOLUÇÃO

A estrutura do conteúdo da solução é definida de acordo com o tipo de informação a ser incluída na base de conhecimento e deve conter informações suficientes para resolver o problema e/ou dúvida constatados. Antes de estruturar o conteúdo do texto nos artigos, confira as instruções abaixo:

PADRÃO DE ARTIGOS NO TDN

Idioma Português

Fonte para título Padrão TDN

Fonte para texto Parágrafo

Fonte para subtítulo Título 3

Cor da fonte de texto Cor automática do TDN (Preto). Podendo utilizar os tons de Azul e Cinza. Cor da fonte para títulos e subtítulos Cor automática do TDN (Preto).

Podendo utilizar os tons de Azul e Cinza.

Marcador Utilize o marcador padrão do TDN:

 (Bolinha) .

Pode ser utilizado quando houver opções ou tópicos. Evite o uso de marcadores em passo a passo. Neste caso, utilize numeradores.

Numerador Utilize o numerador Evite utilizar três níveis de numeração. Ex.: 1.1.1) A melhor sugestão é usar até o 2º nível (1.1) no máximo. Utilize apenas quando estritamente necessário.

Padrão para nome de itens (funções) e rotinas

O nome dos itens (tela, campo, botões, rotina etc) deve ser

apresentado em negrito. Ex.: botão Cancelar. Se o texto estiver muito carregado de palavras em negrito, verifique quais das palavras merecem maior destaque e negrite apenas elas. Ex.: Em situações

Instrução de Trabalho - IT V 1.3 Página 3 de 7 como código e parâmetro e código e descrição de rotinas, usar negrito apenas no código.

Nome de itens com palavras incompletas

Informe o item como é apresentado no sistema. Se a palavra estiver incompleta, comece informando o seu significado e em seguida o nome do item.

Ex.: 1) Informe o percentual do lucro no campo Per. Luc..

Padrão para Tags As Tags devem ser incluídas no artigo de acordo com os seguintes critérios a fim de facilitar a busca por artigos:

 Devem ser inseridas palavras-chaves (substantivos, verbos e adjetivos).

 Não devem ser utilizadas preposições (de, do, para) e artigos (o, a, um, uma).

 Devem ser evitadas palavras comuns no cenário da PC Sistemas como rotina e WinThor por exemplo.

 Deve ser utilizado como tag o ID do artigo.

Observação: o prazo máximo para que o artigo esteja disponível na pesquisa é de 24h.

Orientações gerais

1) Lembre-se quem é o seu público (interno ou externo). Mantenha o contexto do usuário. Para o público técnico, informações técnicas podem ser utilizadas. Para público usuário externo não deve ser utilizada informação técnica.

1.1) Saiba o nome do item antes de descrevê-lo. Substitua a palavra grid por planilha. Grid é uma informação técnica.

1) Informações duplicadas não devem existir.

2) As correções a serem implementadas no sistema não podem ser citadas ou referenciadas.

3) Código e descrição dos produtos devem ser informados. Ex.: 203 – Cadastrar Produto

 Se houver o mesmo produto citado mais de uma vez no texto, informe apenas o código do produto. Ex.: 203; Neste caso, não é necessária sua descrição.

4) Pequenas ilustrações/imagens podem ser utilizadas de acordo com a necessidade.

Instrução de Trabalho - IT V 1.3 Página 4 de 7 e não podem duplicar o conteúdo do documento.

6) As abreviaturas e siglas devem vir acompanhadas de seu significado (entre parênteses). Ex.: NCM (Nomenclatura Comum do MERCOSUL). Evite redundâncias: se em um parágrafo anterior (próximo) o significado da abreviatura já foi informado, não é necessário informá-lo novamente.

7) Deve-se usar sempre o corretor ortográfico e alinhamento do parágrafo ajustado.

8) A posição de campo, botões em texto não devem ser informadas. Ex.: o botão cancelar encontra-se abaixo da tela principal.

9) Evite o uso da palavra usuário. O seu uso em demasiado “empobrece” o documento.

10) Verbos e preposições devem ser evitados no início de um parágrafo. Ex Exemplo 1: Para melhor acompanhamento do histórico é necessário que...

Exemplo 2: Poderá ser inserido o código de barras gerado pela balança na aba "Digitar Bônus".

11) Descrever o item na ordem em que se encontrar no fluxo do passo-a-passo.

Na tela inicial, botão Novo e não no Botão Novo, na tela inicial.

ATENÇÃO: É essencial o entendimento do conteúdo para que a informação seja estruturada e padronizada de forma correta.

2.1. TIPOS DE ARTIGOS

O documento da Base de Conhecimento é considerado como Artigo e deve ser documentado de acordo com a Dúvida e/ou Problema apresentado pelo Usuário em FAQ, Tutorial ou Vídeo Tutorial:

2.1.1.

FAQ

Pergunta e Resposta sem necessariamente apresentação em passo a passo. Utilize o passo a passo somente se for orientar na execução do processo da rotina. Veja instruções e exemplos abaixo:

Instrução de Trabalho - IT V 1.3 Página 5 de 7

Produto Informar a qual Produto a solução pertence.

Título Texto simplificado sobre a dúvida do usuário e coerente ao contexto da solução.

Resposta Texto descritivo sobre a solução apresentada, podendo-se utilizar passo-a-passo, quando se tratar de procedimentos a serem executados ou texto direto, para pergunta e resposta, podendo utilizar imagens e/ou anexos para maior clareza e melhor compreensão da informação.

Exemplo 1: Texto direto

Título: Como é realizado o cálculo da Sugestão do Preço de Compra? Resposta:

A sugestão de compra apresentada na coluna Sugestão da planilha, obedece a seguinte fórmula: SugestãoDeCompra = EstoqueIdeal - EstoqueDisponível - Qt Pedida

Onde:

 EstoqueIdeal = GiroDia x (TempoReposiçãoProduto + TempoPrazoEntregaFornecedor)

 Tempo Reposição Produto = Cadastrado na rotina 203 - Cadastrar Produto, aba Cond. Compra, Opção Tempo Reposição.

 Tempo Prazo Entrega Fornecedor = Cadastrado na rotina 202 - Cadastrar Fornecedor, aba Cond. Comerciais, Opção Prazo Entrega (Led Time): X dias.

 EstoqueDisponível = QtdeEstoque - QtdeReservada – QtdeAvaria, poderá ser visualizado na rotina 1118 - Extrato de Produto.

 Qt Pedida = Também poderá ser consultada através das rotinas 1118- Extrato do Produto e 211 - Consultar Pedido de Compra, Campo Situação opção Pendentes.

Exemplo 2: Texto com necessidade de procedimentos passo-a-passo

Título: Como é realizado o cadastro de NCM (Nomenclatura Comum de Mercosul)? Resposta:

O código do NCM deverá ser informado pelo contador da empresa. Em seguida, realize o seguinte procedimento:

Para o cadastro de NCM, marque as seguintes permissões da rotina 530 – Permitir Acesso a Rotina: 1 – Permitir incluir novo código NCM;

Instrução de Trabalho - IT V 1.3 Página 6 de 7

2 – Permitir editar código NCM;

4 – Permitir Ativar/Inativar código NCM. Em seguida:

1) Acesse a rotina 580;

2) Clique no botão Incluir;

3) Informe Cód. NCM e sua Descrição;

4) Clique no botão Gravar para confirmar o cadastro do NCM.

Exemplo 3: Mensagem de erro

Título: Erro PVA: A conta de resultado (número) utilizada em lançamentos do tipo "TR", "X" e "F" ... Resposta:

Este artigo descreve como proceder ao encontrar a seguinte mensagem de erro durante análise do arquivo FCONT.txt (Controle Fiscal Contábil de Transição) no PVA (Programa Validador de Arquivos) da Receita Federal: "A conta de resultado (número) utilizada em lançamentos do tipo "TR", "X" e "F" não possui um lançamento de contrapartida do tipo EF que permita o encerramento dos lançamentos EF + TR + F + (-)X deva ser igual a zero".

Para realizar os procedimentos deste artigo é necessário que a rotina 2132 - Geração de Arquivos Contábeis seja utilizada.

Para que o arquivo FCONT.txt seja gerado durante a sua validação no PVA sem o impedimento apresentado na mensagem de erro acima informada, é necessário verificar a existência do movimento contábil para uma das empresas do grupo (Matriz e Filial) selecionado e se o encerramento do exercício ainda não foi realizado.

Observação: Se o exercício não estiver encerrado, encerre-o de acordo as orientações do passo 14 no Tutorial FCONT anexo.

2.1.2.

TUTORIAL

É um documento com o objetivo de instruir o usuário num determinado processo do sistema, exibindo o seu passo a passo. Como sugestão, veja o padrão para elaboração do conteúdo em IT.EPR. 003 – Padrões

para Elaboração do Documento do Produto, item 3 – Tutorial e para documentá-lo, utilize o RQ.GBC.001-Template Tutorial.

No campo para edição de texto da Base de Conhecimento, use o padrão abaixo:

Instrução de Trabalho - IT V 1.3 Página 7 de 7

Veja exemplo da caixa abaixo:

Título: Como é realizada a Venda Express? Resposta:

A Venda Express pode ser realizada de acordo com o Tutorial <Titulo do Tutorial>.

2.1.3.

VIDEO TUTORIAL

É um documento em áudio e vídeo com o objetivo de instruir o usuário num determinado processo do sistema, exibindo o seu passo a passo. O vídeo tutorial deverá demonstrar um processo breve, recomenda-se não ultrapassar a faixa de 5 (cinco) minutos.

O conteúdo do Vídeo Tutorial deve ser de caráter explicativo e orientado, com informações detalhadas, claras, de fácil entendimento e com demonstração da execução do processo.

A linguagem utilizada deve ser simples e objetiva, evitando vícios de linguagem.

Antes da gravação deve ser criado um roteiro para orientação da sequência das ações do processo. Veja abaixo exemplo de roteiro:

Vídeo Tutorial Geração de Ordem de Produção

Olá, saiba como.../ Olá, aprenda a.../ Olá, hoje você verá como...

...gerar uma Ordem de Produção por meio da rotina 1615 – Programar Ordem de Produção, após a estruturação do produto acabado.

Veja como fazer: