/
Layout da Página de Documentação

Documentação Técnica VIASOFT

Layout da Página de Documentação

Nesta documentação você aprendera como criar a estrutura da documentação.

Esta etapa é muito importante, pois da mesma forma que o caminho das rotinas, deve se manter uma identidade visual padrão para todas as verticais e equipes.

Índice

 


1. Padrão de Títulos

No título deve ser utilizado o Estilo de Texto: Título 1

Caso seja preciso quebrar em sub-títulos, utilizar o estilo de Título 2. Se preciso quebrar em novos níveis de título, utilizar os demais estilos seguindo a sequência.


2. Divisória

A divisória deve ser utilizada para criar intervalos entre um título e outro.


3. Estrutura do documento

Observe abaixo como deve ser construído a documentação. Este é um padrão que deve ser seguido para manter uma consistência das documentações geradas no confluence e uma identidade visual.

3.1. Descrição

3.1.1. Painel de Informações

Após o título, deve informar um resumo do que a documentação ira falar. Este resumo deve ser informado em um Painel de Informações.


3.2. Índice

Utilizar o recurso Índice.

 

3.3. Pré-Requisitos

Neste item, informe os pré-requisitos para utilizar a rotina:

Utilizar o recurso de Lista de Marcadores (Ctrl+Shift+8), conforme exemplo acima.


3.4. Passo-a-passo

Neste item, informe o passo-a- passo a ser realizado pelo usuário:

Utilizar o recurso de Lista Numerada (Ctrl+Shift+7), conforme exemplo acima.

É possível utilizar imagens nesta etapa, mas o mesmo deve ser utilizado de forma muito pontual para facilitar a manutenção do documento no futuro. Priorize a documentação apenas por escrito.


3.5. Dicionario de Dados

O dicionário de dados, nada mais é, que o lugar onde deve ser documentado o que cada campo da rotina faz.


3.6. Erros Comuns

Nos erros comuns, deve ser documentado as principais situações que podem vir a ocorrer caso seja parametrizado ou utilizado algo de forma incorreta.


3.7. Versão

Aqui deve ser informado informações relevantes a versão do documento que corresponde a versão do sistema.

Exemplo:


Importante seguir essa documentação a risca, e caso tenha alguma dúvida ou sugestão, comunicar a equipe de Capacitação da Viasoft.


4. Templates

 

Para agilizar sua documentação, pode ser utilizado um Template já salvo:

 

Related content

Agrotitan
Agrotitan
Read with this
Página das Documentações
Página das Documentações
More like this
Recepção de Pedidos
Recepção de Pedidos
Read with this
Configuração controle de rentabilidade
Configuração controle de rentabilidade
Read with this
Aba Formação de preço
Aba Formação de preço
Read with this