¶ Manuais
¶ Seções
Usadas para dividir um conteúdo, quanto, por exemplo, a instrução envolve diversas ações distintas ou complexas, facilitando a compreensão do usuário. Para a adicionar seções são usados os títulos e subtítulos em linguagem de marcação Markdown.
# Título um
//gera um seção principal
## Título dois
//gera uma seção secundária
//outras seções, quatro, cinco e seis, não aparecem no índice da página, levando somente a um destaque do texto.
¶ Passos
por padrão tem sua numeração destacada, em negrito, de modo que seja possível identificálos com facilidade em meio ao texto.
**Passo 01** Texto descritivo do passo
//observe que não há elemento de texto após a indicação do passo. Busque descrever as etapas de forma simplificada e detalhada.
¶ Blocos
Servem para destacar um texto específico. Observe os tipos de blocos:
De avisos: utilizados quando uma ação pode levar a uma situação crítica, via de regra, prejudicial;
> Isto gera um bloco de avisos
{.is-warning}
De informação: utilizado para prestar informações complementares de grande relevância, fora dos passos, mas que merecem especial destaque;
> Isto gera um bloco de informação
{.is-info}
De erro: serve para informar sobre algum possível erro do procedimento;
> Isto gera um bloco de erro
> {.is-danger}
{.is-danger}
De texto: utilizado para textos imortantes que não integram o passo a passo do manual (preferencialmente não utilizado);
> Isto gera um bloco de texto
De sucesso: Indicado para quando desejamos apontar o sucesso de um procedimento, ou a conclusão de algum projeto.
> Isto gera um bloco de sucesso
{.is-success}
Resultado:
aviso
informação
erro
texto
sucesso
¶ Códigos
Quando a informação for um código, é recomendado que sejam criados blocos, da seguinte forma:
Resultado:
¶ Tabelas
A consolidação de muitos conteúdos pode ser feita através de tabelas, de modo a concentrar as informações.
As tabelas podem ser feitas, preferencialmente por meio do HTML5:
<table class="ui left definition table"> //abertura e classe da tabela
<thead> //cabeçalho da tabela
<tr>
<th> //títulos
<p class="descri-manual">Título 1</p>
</th>
<th>
<p class="descri-manual">Título 2</p>
</th>
<th>
<p class="descri-manual">Título 3</p>
</th>
<th>
<p class="descri-manual">Título 4</p>
</th>
<th>
<p class="descri-manual">Título 5</p>
</th> //fechamento dos títulos
</tr>
</thead> //fechamento do cabeçalho
<tbody> //corpo da tabela
<tr>
<td></td>
<td><a href="#" target="_blank">
<p class="versao">
<button type="button" class="ml-3 v-btn v-btn--depressed
theme--dark v-size--default blue darken-2" style="flex: 1 1 100%;">
<span class="v-btn__content">
<div class="body-2 text-none">Nome do botão (geralmente, acessar)</div>
</span>
</button>
</p>
</a>
</td>
<td>
<p class="descr-grid-normal">Texto descritivo</p>
</td>
<td>
<p class="versao">Sistema</p>
</td>
<td>
<p class="versao">Número da versão</p>S
</td>
</tr>
</table> // fechamento da tabela
¶ Resultado
|
Procedimentos |
Descrição |
Sistema |
Versão |
|
|---|---|---|---|---|
|
|
Texto descritivo |
Sistema |
Número da versão |
¶ Notificação de Erros
Quando verificada a ocorrência de algum erro no uso de sistemas é necessário documentá-lo, desde a sua causa, solução temporária a definitiva de modo a promover melhoria contínua.
¶ Identificação por tabela
Nome do erro: indicação do erro com (série);
Exemplo: gprob_0000: Modelo (inserir nome do problema).
Problema: número na listagem geral;
Tipo: requisição/incidente;
Origem: descrição de como o problema foi identificado, quais os métodos e ações tomadas para a respectiva descoberta;
Equipe responável: a quem se atribuía o serviço;
Dano no processo: descrição de tudo o que foi afetado pelo problema, bem como impacto de negócio e consequências de não resolução do problema;
Alvos: lista de secretarias e serviços afetados;
<br>
<table class="ui celled structured table">
<thead>
<tr>
<th>
<p class="titulo">Problema</p>
</th>
<th>
<p class="titulo">Tipo</p>
</th>
<th>
<p class="titulo">Origem</p>
</th>
<th>
<p class="titulo">Equipe responsável</p>
</th>
<th>
<p class="titulo">Dano do processo</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td><p class="texto">0000</p></td>
<td><p class="texto">Reativo/preventivo</p></td>
<td><p class="texto">Reparo/melhoria/atualização</p></td>
<td><p class="texto">Nome aqui</p></td>
<td><p class="texto">Descrição do dano</p></td>
</tr>
<thead>
<tr>
<th>
<p class="titulo">Alvos</p>
</th>
<th><p class="texto"></p></th>
<th><p class="texto"></p></th>
<th><p class="texto"></p></th>
<th>
<p class="titulo">Observações</p></th>
</thead>
<tbody>
<tr>
<td><p class="texto">Alvos do problema</p></td>
<td><p class="texto"></p></td>
<td><p class="texto"></p></td>
<td><p class="texto"></p></td>
<td><p class="texto">Observações sobre a solução</p></td>
</tr>
</tbody>
</table>
¶ Resultado
|
Problema |
Tipo |
Origem |
Equipe responsável |
Dano do processo |
|---|---|---|---|---|
0000 |
Reativo/preventivo |
Reparo/melhoria/atualização |
Nome aqui |
Descrição do dano |
|
Alvos |
Observações |
|||
Alvos do problema |
Observações sobre a solução |
¶ Incidentes relacionados
No caso de haver incidentes relacionados, listá-los de modo tabular da seguinte forma, facilitando a identidicação:
<br>
<table class="ui celled structured table">
<thead>
<tr>
<th>
<p class="titulo">ID</p>
</th>
<th>
<p class="titulo">Categoria</p>
</th>
<th>
<p class="titulo">Descrição</p>
</th>
<th>
<p class="titulo">Data</p>
</th>
<th>
<p class="titulo">Origem</p>
</th>
</tr>
</thead>
<tbody>
<tr>
<td><p class="texto">ID no GLPI</p></td>
<td><p class="texto">Categoria da solicitação/incidente</p></td>
<td><p class="texto">Descrição do ocorrido</p></td>
<td><p class="texto">Data do evento</p></td>
<td><p class="texto">Atendimento, rotina de verificação, monitoramento e etc</p></td>
</tr>
</table>
¶ Resultado
|
ID |
Categoria |
Descrição |
Data |
Origem |
|---|---|---|---|---|
ID no GLPI |
Categoria da solicitação/incidente |
Descrição do ocorrido |
Data do evento |
Atendimento, rotina de verificação, monitoramento e etc |
¶ Solução de contorno
- Procedimento para contornar o problema momentaneamente, evitando a paralisação da prestação de serviço.
- Solução de contorno alternativa, se houver.
¶ Procedimentos
- Procedimento para reparo do problema (pode-se inserir link externo).
- Procedimento alternativo, se houver.
¶ Proposta de solução definitiva
Descrever a solução definitiva do problema.
¶ Em breve
- Procedimentos Operacionais
- Estudos Técnicos
- Projetos