Instrução de Trabalho - IT V 1.1
Sumário
1. DEFINIÇÃO ... 2
1.1. PROBLEMA/DÚVIDA ... 2
1.2. SOLUÇÃO ... 2
2.1. INFORMAÇÕES QUE REFORÇAM A ESTRUTURA DA SOLUÇÃO ... 4
Instrução de Trabalho - IT V 1.1
1. DEFINIÇÃO
1.1. PROBLEMA/DÚVIDA
O problema/dúvida representa um resultado indesejável, tal como uma mensagem de erro ou algo que não funciona como o esperado pelo cliente, ou que ele não sabe como utilizar, podendo ser definido como o sintoma e aquilo que o cliente está tentando fazer e não está conseguindo.
1.2. SOLUÇÃO
Uma solução representa a experiência do usuário, o resultado obtido pelo analista com a solução de um evento e as informações para a empresa, no que diz respeito ao ciclo de vida da solução, que a torna reutilizável.
2. ESTRUTURA DA SOLUÇÃO
A estrutura do conteúdo da solução é definida de acordo com o tipo de artigo a ser incluído 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:
INSTRUÇÕES
Idioma Português
Fonte para texto Arial 10 Fonte para título Arial 14 Fonte para subtítulo Arial 12
Cor da fonte de texto Preto acinzentado composto pela combinação de cores: Vermelho: 69,
Verde: 69, Azul 69
Cor da fonte para títulos e subtítulos *Exceto para títulos da Ajuda, pois ela
é de cor branca.
Azul composto pela combinação de cores: Vermelho 31, Verde 73 e Azul 125
Marcador padrão (bolinha) .
Instrução de Trabalho - IT V 1.1 passo a passo. Neste caso, utilize numeradores.
Numerador padrão 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 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..
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) Se o dado técnico estiver seguido de uma informação descritiva, conforme exemplo da rotina 560 – Atualizar Banco de Dados, utilize como regra abaixo:
-Para técnicos: Tabela de agenda de usuário (PCAGENDA). -Para usuários: Tabela de agenda de usuário.
1.2) 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.1 5) Caso existam anexos, eles devem ser visíveis e complementares,
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. INFORMAÇÕES QUE REFORÇAM A ESTRUTURA DA SOLUÇÃO
Atributos Qtde. de acesso ID artigo Estado da solução Metadados Autor Data da publicação Data da última atualização
Instrução de Trabalho - IT V 1.1
2.2. 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 ou Tutorial:
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:
CONTEÚDO NECESSÁRIO DESCRIÇÃO
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 (sem necessidade de exposição em forma de procedimento).
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 (a partir da versão 17.01.01), aba Cond. Compra, Opção Tempo Reposição.
Tempo Prazo Entrega Fornecedor = Cadastrado na rotina 202 - Cadastrar Fornecedor (a partir da versão 17.00.01) – 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 a partir da versão 17.01.01).
Qt Pedida = Também poderá ser consultada através das rotinas 1118- Extrato do Produto (a partir da versão 17.00.02) e 211 - Consultar Pedido de Compra (a partir da versão 17.00.03), Campo Situação opção Pendentes.
Instrução de Trabalho - IT V 1.1 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;
2 – Permitir editar código NCM;
4 – Permitir Ativar/Inativar código NCM. Em seguida:
1) Acesse a rotina 580 a partir da versão 16.00.01;
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 a partir da versão 16.11.03.
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
Instrução de Trabalho - IT V 1.1 Tutorial: É um documento com o objetivo de instruir o usuário num determinado processo do
sistema, exibindo o seu passo a passo. Veja o padrão para elaboração do conteúdo em EPR. 003 – Padrões para Elaboração do Documento do Produto, item 3 – Tutorial e para documentá-lo, utilize o Template - Tutorial.
No campo para edição de texto da Base de Conhecimento, use o padrão abaixo:
<Nome do Processo> pode ser realizado (a) de acordo com o Tutorial anexo.
Veja exemplo da caixa abaixo:
Título: Como é realizada a Venda Express? Resposta:
A Venda Express pode ser realizada de acordo com o Tutorial anexo.
Boletim de Evolução da Versão: É um documento com o objetivo de informar sobre as novidades no produto a cada versão.
No campo para edição de texto da Base de Conhecimento, use o padrão abaixo:
O Boletim de Evolução da Versão <Nº da versão> encontra-se disponível no documento anexo.
Veja exemplo da caixa abaixo:
Título: Boletim de Evolução da Versão <Nº da versão> Resposta:
