Esse tópico contempla os modelos de documentos a serem utilizados nas documentações da Alterdata, os itens não contemplados nesse tópico devem seguir os critérios estabelecidos nos demais tópico desse guideline.
Assim como, o passo a passo, para sua correta aplicação e utilização.
Selecione o template de acordo com o objetivo da publicação a ser criada.
Os templates disponíveis são:
| Tipo de Documentação | Nome | Objetivo |
|---|---|---|
| Novidades da Versão | Novidades das Versões | Página principal com atalhos a listagem |
| Listagem dos processos | Bimer: Bimer | Novidades da Versão - Listagem Shop: Shop | Novidades da Versão - Listagem Immobile: Immobile| Novidades da Versão - Listagem Pack: Pack | Novidades da Versão - Listagem eContador: eContador | Novidades da Versão - Listagem NF-Stock: NF-Stock | Novidades da Versão - Listagem Interfacenet: InterfaceNet | Novidades da Versão - Listagem | Página com o texto de novidades da versão (release notes) |
| Primeiros Passos | Primeiros Passos | Primeira página do tópico de primeiros passos. |
| Passo a Passo | Leia o tópico Passo a Passo | Página com um dos passos do primeiros passos. |
| Destaque da versão | Destaque da Versão | Destacar os principais recursos da versão liberada. |
| Cadastros | SQA - Template Cadastro | Página com os elementos necessários para página de Cadastro |
| Página Pai | SQA - Template Página Pai | Página com os elementos necessários para criação da página pai da documentação de um sistema. |
| Página Geral de Cadastro | SQA-Template Página Geral Cadastro | Apresenta a listagem dos cadastros do sistema |
| Página Geral Relatórios | SQA-Template Página Geral Relatórios | Apresenta a listagem dos relatórios do sistema |
| Relatórios | SQA-Template Relatórios | Página para detalhamento do passo a passo de configuração e execução de um relatório. |
Não altere o estilo e diagramação dos templates ao preenchê-los.
2.1. Preenchimento dos templates
2.1.1. Novidades da Versão
Todos os templates relacionados a novidades da versão possui explicações no próprio corpo do template de como preenchê-los ou configurá-los. Para elementos visuais, layout e navegação, siga os mesmos critérios de utilização do Alterdata Human Interface Guidelines (HIG).
2.1.2. Primeiros passos
2.1.2.1. Primeira Página
Edite os itens indicados na imagem abaixo:
- Título: Altere a cor do texto para a cor primário do sistema ao qual o passo a passo se refere.
- Diagrama com os passos:
- Altere o diagrama com os passos do respectivo sistema.
- Altere as cores para a cor primária e secundária do sistema a que se refere.
- Insira um link em cada item do diagrama para a página a qual se refere.
Insira o nome do sistema, e em "clique aqui" insira um link para a página inicial da documentação
Altere o texto abaixo do título, informando os procedimentos que o usuário será capaz de realizar ao seguir os passos, como no exemplo da imagem ao lado.
2.1.3 Cadastro
O template de cadastro possui explicações e exemplos de como preenchê-los ou configurá-los no próprio corpo do template. Para elementos visuais, layout e navegação, siga os mesmos critérios de utilização do Alterdata Human Interface Guidelines (HIG).
2.1.4 Página Pai
O template da página pai possui explicações e exemplos de como preenchê-los ou configurá-los no próprio corpo do template. Para elementos visuais, layout e navegação, siga os mesmos critérios de utilização do Alterdata Human Interface Guidelines (HIG).
2.1.5 Página Geral de Cadastro
O template da página Geral de Cadastro possui explicações e exemplos de como preenchê-los ou configurá-los no próprio corpo do template. Para elementos visuais, layout e navegação, siga os mesmos critérios de utilização do Alterdata Human Interface Guidelines (HIG).
2.1.6 Página Geral de Relatórios
O template da página Geral de Relatóros possui explicações e exemplos de como preenchê-los ou configurá-los no próprio corpo do template. Para elementos visuais, layout e navegação, siga os mesmos critérios de utilização do Alterdata Human Interface Guidelines (HIG).
2.1.7 Relatórios
O template da página de Relatórios possui explicações e exemplos de como preenchê-los ou configurá-los no próprio corpo do template. Para elementos visuais, layout e navegação, siga os mesmos critérios de utilização do Alterdata Human Interface Guidelines (HIG).