Serviço Nacional de Aprendizagem Comercial do Rio Grande do Sul
Informação e Comunicação
Habilitação Técnica de Nível Médio Técnico em Informática
Manuais Técnicos
Boas práticas
Prof. Dartagnan Farias
[email protected]

O que são manuais?
◦ Documentos técnicos que viabilizam a utilização
e/ou procedimento correto de determinada
atividade.
◦ As informações são dispostas de maneira sistêmica
e lógica, tornando-o um documento facilitador para
o usuário.
◦ São documentos permanentes a fim de serem
consultados por usuários quando estes o
necessitam.
2

Qual a importância dos manuais?
◦ Essenciais para conhecimento correto de uma
organização, sistema, fluxos, processos, maneira
de usar, etc;
◦ São documentos responsáveis por mostrar “como
fazer” algo ou determinada atividade;
◦ Treinamento de pessoas;
◦ Garantir a qualidade de atividades ou processos
realizados.
3

Manuais têm por objetivos:
◦ Mostrar a maneira correta de realizar alguma
atividade e/ou processo;
◦ Conhecer
uma
organização
ou
instituição
considerando:
 Sua estrutura organizacional;
 Seus processos;
 Suas regras.
◦ Atender normas de qualidade;
◦ Mostrar maneiras de utilização de produtos e/o
serviços.
4



Facilitam o processo de efetivar normas,
regras, procedimentos;
Padronizam a maneira de realizar atividades
e/ou operações;
Definem critérios e padrões a serem
seguidos.
5



Possibilitam
a
realização
de
atividades/operações por diversas pessoas
sem
conhecimento
específico
sobre
determinado assunto;
Mostram as restrições para improvisos
inadequados;
Mostram responsabilidades dentro de uma
organização / instituição.
6


Quando mal elaborados, representam riscos,
pois podem ser utilizados de maneira
inadequada.
Se mal escritos (textualização não clara,
objetiva) tornam-se ferramentas de difícil
compreensão.
7

Manual de organização e manual de estrutura
◦ Foco na apresentação da organização;
◦ Constituição de seus setores;
◦ Organograma da empresa.
8

Manual de Processo, Manual de Serviços e
Manual de Instruções:
◦ Definem a maneira correta de realizar algum tipo
de procedimento.
9

Manual de Formulários:
◦
◦
◦
◦
Define a finalidade de um formulário;
Os dados a serem preenchidos;
Informa os dados obrigatórios a serem informados;
A distribuição e utilização do formulário;
10

Manual de normas:
◦ Expressam regras a serem seguidas;
◦ Semelhante a qualquer tipo de regulamento ou
regimento.
11

Manual de sequência:
◦ Descreve as fases e as operações de cada processo
de forma detalhada;
◦ Também informa a ordem em que os processos
devem ser realizados.
12

Os principais manuais na área de TI são:
◦ Manuais de instrução
 Manuais de instalação;
 Manuais de utilização.
13

Para que servem?
◦ Informam a maneira correta de realizar a instalação
e/ou utilização de determinado hardware ou
software.
◦ São a garantia de que o produto instalado
funcionará da maneira desejada ou que o processo
realizado resultará no objetivo do usuário.
14

Objetivo:
◦ Garantir de que o produto (hardware ou software)
realizará suas funcionalidades de maneira correta,
assim como o especificado pelo fabricante.
15

Estrutura:
◦ Elementos pré-textuais:
 Capa;
 Índice ou Sumário.
◦ Corpo




Objetivos do manual;
Requisitos (não obrigatório);
Detalhamento dos processos (passo a passo);
Resultado final após o processo.
◦ Elementos pós-textuais
 Glossário com termos técnicos.
16

A capa deve conter:
◦ Nome do Software ou Hardware (Título);
 Deve-se considerar a versão e/ou modelo.
◦ Nome do Manual (Subtítulo);
◦ Nome do desenvolvedor do manual
◦ Data de desenvolvimento do manual
 [Mês] de [Ano] Exemplo: Abril de 2013

A capa pode conter:
◦ Imagens (logo da empresa desenvolvedora, logo do
software, ilustração do hardware)
◦ Versão do Documento
17

A capa não pode conter:
◦ Cabeçalhos e rodapés;
◦ Numeração de páginas.
18

Exemplo de Capa
19

O índice deve conter:
◦ Títulos e subtítulos numerados;
◦ Indicação em que página se encontra os títulos e
subtítulos;
◦ Cabeçalhos e rodapés:





Logo do Software e/ou da empresa (não obrigatório);
Nome do sistema e versão;
Título do Manual;
Versão do manual.
O índice pode conter:
◦ Numeração de páginas.
20
21

Ao desenvolver o conteúdo do corpo, deve-se
padronizar:
◦ Fonte dos títulos e subtítulos
 Todos títulos devem ser numerados e possuírem o
mesmo padrão de fonte;
 Todos os subtítulos devem ser numerados e
possuírem o mesmo padrão de fonte;
 Deve-se utilizar o mesmo cabeçalho e rodapé do
índice, porém acrescido de numeração de páginas;
 Os parágrafos devem possuir o mesmo padrão de
fonte, o mesmo espaçamento entre parágrafos e as
mesmas margens;
22
 Palavras estrangeiras devem ser colocadas em itálico;
 Detalhes textuais a serem realçados devem estar em
negrito.
23

No objetivo do manual deve-se apresentar a
razão geral para o manual ter sido
desenvolvido.
24


Nos Requisitos informamos quais as
características necessárias para que a
operação / instalação possa ser realizada
com sucesso;
Estas características compreendem:
◦ Requisitos de máquinas (hardware);
◦ Requisitos de sistemas (software)
◦ Requisitos de dependência.
25

Exemplo de requisitos de máquinas
(Normalmente encontrado em manuais de
instalação):
◦ Processador: 1,5 Ghz ou superior;
◦ Memória Ram: 2Gb.

Exemplo de Requisitos de Sistemas
(Normalmente encontrado em manuais de
instalação):
◦ Windows 7 ou Superior;
◦ DirectX 9 ou superior.
26

Exemplo de Requisitos de Dependência
(Normalmente quando trata-se de manuais
de procedimentos em um software):
◦ Deve possuir funções cadastradas no sistema.
27

Em manuais de instruções referentes a
instalação, é comum notarmos que os
requisitos são divididos em dois tipos:
◦ Requisitos Mínimos: Informa as características
mínimas de máquina e sistema para realizar a
instalação;
◦ Requisitos Recomendados: Informa as
características ideias para realizar a instalação.
28



Parte mais importante do manual;
Representa o “como fazer” sobre alguma
atividade.
Importante:
◦ Utilizar linguagem clara e objetiva;
◦ Cuidar o duplo sentido nas informações.
29

O que pode conter:
◦ Imagens de cada passo (ajudam bastante);
 Considerar real necessidade de utilizar imagens.
◦ Cada passo pode ser considerado um subtítulo.
30


Neste ponto é apresentado o que resulta ao
usuário após ter realizado todos os passos
descritos no Detalhamento de Processos
(passo a passo).
Pode-se utilizar:
◦ Imagens (auxiliam no entendimento dos
resultados).
31

São dicionários de termos técnicos:
◦ Apresentam a explicação dos termos e
terminologias específicas da área que o documento
aborda.


Diferente de dicionários convencionais, os
glossários permitem a inserção de frases ou
mais de uma palavra que possui explicação
unida.
Devem ser organizados de maneira alfabética
32

Podem conter:
◦
◦
◦
◦
Imagens;
Tabelas;
Gráficos;
Dados que auxiliem o compreendimento do
assunto abordado no documento.
33

Exemplo:
◦ Texto no documento:
 Para realizar a instalação do software LibreOffice
primeiramente realize o download do pacote de
instalação lboffice.exe através do link
http://www.lboffice.org
34
◦ Glossário:
 .exe
 Arquivos com terminação .exe são arquivos executáveis
com a finalidade de realizar algum tipo de modificação
no seu sistema operacional. Normalmente utilizado são
utilizados quando realizamos a instalação de um
software.
 Download:
 É a transferência de um computador remoto (servidor)
para um computador local (maquina do usuário).
 Link:
 Link um link é o "endereço" de um documento (ou um
recurso) na web.
35



Valentim, Marta. Elaboração de manuais, normas,
instruções e formulários. Departamento de
Ciência da informação – Unesp – 2012.
Universidade da Madeira. As normas ISSO 9000.
Disponível em
<http://www.online24.pt/ficheiro/normas-iso9000.pdf>. Acessado em 13 de abril de 2013.
Universidade da Madeira. As normas ISSO 9000.
Disponível em
<http://www.online24.pt/ficheiro/normas-iso9000.pdf>. Acessado em 13 de abril de 2013.
36