Estrutura Help Fluig

O Help online Fluig é um manual para usuários finais, por isso, seguimos alguns padrões para que a documentação fique clara e facilmente compreensível. A estrutura é dividida da seguinte forma:

1. Título: desenvolver um título relacionado ao recurso;

2. Falando de: pequena introdução falando sobre o recurso em si, o que ele faz, seu comportamento, o que melhora para o usuário, informações gerais sobre o recurso.

   Painel
   Deve ser usado o título 1 como padrão;

3. Imagem do recurso: Imagem que represente o recurso em questão;

   Painel
   Padrões para imagem: Print da tela com a janela maximizada do navegor Google Chrome. Deixar a imagem no tamanho original. Destacar o recurso na imagem se necessário.

4. Passo a Passo: Detalhamento de como executar determinada ação disponível no recurso.

Estrutura Passo a Passo

A elaboração do passo a passo de cada ação deve seguir a seguinte formatação:

1. Título: desenvolver um título relacionado a ação (título 3);
2. Linha Horizontal: Acrescentar uma linha horizontal em baixo de cada título ( a linha pode ser adicionada acionando o ícone + no menu superior e em seguida selecionando linha horizontal);
3. LInks: colocar o link do vídeo, imagem ou gif quando necessário juntamente com o ícone específico;

4. Espaço: Deixar um espaço entre os links e os passos. O mesmo não deve ocorrer quando não houverem links;

5. Passo a Passo:  Detalhar cada passo que o usuário deve seguir para efetuar a ação. Separar os passos com números (01. 02. 03...)
   
   

Título da ação

Assista ao vídeo| Veja a imagem |  Visualize o passo a passo

01. Passo 1

02. Passo 2

03. Passo 3

Título da ação

01. Passo 1

02. Passo 2

03. Passo 3

Estrutura Perguntas frequentes

No final de cada página, antes da macro informando a atualização que a documentação pertence, devem ser inclusas as Perguntas frequentes que mais relacionam-se com o assunto da página seuindo a seguinte formatação:

1. Título: Título Perguntas frequentes (título 2);
2. Linha Horizontal: Acrescentar uma linha horizontal em baixo do título ( a linha pode ser adicionada acionando o ícone + no menu superior e em seguida selecionando linha horizontal);
3. LInks: Colocar os links para as FAQs mais importantes relacionada ao assunto da página (máximo 5);
4. Veja mais: Link Veja mais redirecionando para a página principal das FAQs do card em questão ( o link deve ser colocado dentro de uma única célula de uma tabela).

Perguntas Frequentes

link

link

link

link

link

Nota para alterações

• Se for uma correção, irá a data da liberação no título
• Se for uma release, ficará apenas a versão da atualização - Nome da atualização.