Documentação_Modelo de manual do sistema

Objetivo

Descrever o objetivo do manual, Utilizar título 1 para cabeçalho

  • Deve ser breve e já introduzir a pessoa que está lendo ao contexto

Funcionalidade

Aqui estará o cerne de toda documentação, orientações, Utilizar título 1 para cabeçalho

  • Não tem como ser uma fórmula de bolo, pois as rotinas diferenciam entre si;

  • Possuir tópicos para organização Utilizar título 2 para cabeçalho dos tópicos;

    • Nos tópicos, ter os macros de voltar ao topo

  • Possuir macros de expandir;

  • Possuir ícones indicativos(Alerta, Observação, informação, etc..);

  • Sempre procurar mesclar linguagem verbal e não verbal;

  • Caso tenha vídeo de como fazer cada etapa, incluir no DOC

 

Exemplo:

1- Fluxo do processo



2- Configuração

Para funcionamento da rotina, deverá ter a seguinte configuração:

Rotina: Caminho no sistema

3- Cadastro



4- Rotina

Ir na rotina x, selecionar botão X

Ao clicar no botão processar, o sistema terá o seguinte comportamento

A clicar no botão recusar, o sistema terá o seguinte comportamento

5- Etc..



Exemplos de macros:

1- Índice: 

2- Voltar ao Topo 

3- Expandir

adsdasd

 



4- Aviso

Aviso!

5 - Nota

Nota

6- Informações



7- Dica



Related content

Manual do Sistema de Custos
Manual do Sistema de Custos
More like this
Escala de Plantões dos servidores
Escala de Plantões dos servidores
More like this
Manuais_Escala de Plantões dos servidores
Manuais_Escala de Plantões dos servidores
More like this
Integração com Feriados Municipais
Integração com Feriados Municipais
More like this
Manuais_Justificativas do ponto
Manuais_Justificativas do ponto
More like this
Manuais_Plantões de servidores Funcionalidade
Manuais_Plantões de servidores Funcionalidade
More like this