- Principais características das instruções
- Estrutura
- 1. introdução
- 2- Pontos de contato
- 3- Principais funções de negócios
- 4- Glossário
- 5- Recursos do sistema ou produto
- 6- Descrição das funções
- 7- Preparação das funções de entrada
- 8- Resultados
- 9- Instruções de operação
- 10- Manutenção
- 11- Erros
- Exemplos de instruções
- 1- Instruções para montagem da cadeira
- Segurança
- Plano de construção
- Diagrammer
- Calculadora LTA
- Referências
Um instrutivo é um documento que visa dar algumas informações sobre como fazer algo em particular. Esses textos servem como um guia para o indivíduo saber a maneira correta de realizar uma ação ou de se informar sobre algo.
A maioria das instruções tem um guia escrito ou texto com as instruções, além de algumas imagens associadas (como diagramas) que podem ajudar o indivíduo a entender a pergunta.
A ideia é que as instruções sejam escritas de forma não técnica para que possam ser entendidas pelo maior número de pessoas.
O nível de terminologia técnica e o nível de conteúdo devem ser diferentes de um guia especializado, porque as instruções devem ser destinadas ao cidadão comum.
Por isso, é importante definir a quem se dirige o guia; leitores diferentes terão requisitos diferentes.
Adicionalmente, as instruções devem ter uma estrutura que inclua a capa, a introdução, o glossário, a descrição geral e as instruções, entre outros elementos.
Como o nome indica, as instruções são textos escritos para ajudar as pessoas a entender como usar um sistema.
Geralmente, as instruções são necessárias na implantação de um sistema de software tecnológico, montagem de alguns móveis ou instruções de uso de um dispositivo eletrônico.
As instruções devem ser o primeiro item a ser lido na compra de um novo produto.
Com a leitura do manual de instruções, muitas dúvidas sobre o mesmo podem ser esclarecidas sem a necessidade de suporte técnico ou suporte do fabricante.
Principais características das instruções
- Instruções passo a passo sobre como usar o produto estão incluídas.
- Contêm absolutamente todas as instruções do produto, de todas as formas possíveis.
- Eles começam com um guia do usuário rápido de uma página.
- Eles informam ao usuário quais são as funções do produto e para que servem, não apenas como usar essas funções.
- Eles levam em consideração as necessidades dos usuários com deficiência (como baixa visão ou daltonismo) e fornecem instruções alternativas para esses usuários, como áudio, braille ou impressão maior.
- Eles usam apenas um idioma.
- Eles têm um uso eficaz da cor.
- Suas páginas são numeradas e possuem índice.
- Possuem fotos ou diagramas que ajudam a entender o produto e as instruções.
- Usam uma fonte limpa e legível; isso significa que eles não usam fontes serif.
Estrutura
1. introdução
Contém todas as informações essenciais para o usuário utilizar todo o sistema ou produto. Esta parte deve incluir uma descrição das funções do sistema e suas capacidades, contingências e modos alternativos de operação, procedimentos e uso passo a passo.
Se possível, use gráficos. Esta seção também fornece uma descrição do objetivo do tutorial, sua organização e possíveis referências.
2- Pontos de contato
Esta seção identifica os códigos da organização e da equipe que podem ajudar o usuário. Se houver qualquer linha de ajuda ou help desk, ela será descrita nesta seção.
3- Principais funções de negócios
Esta seção inclui a perspectiva de negócios das responsabilidades primárias do usuário com relação ao produto ou sistema.
4- Glossário
Aqui está o glossário de termos e abreviações usados nas instruções. Se for muito longo, mais do que algumas páginas, é colocado como um apêndice.
5- Recursos do sistema ou produto
Esta parte fornece um breve resumo do sistema e recursos do produto; seu propósito deve ser descrito.
A ideia é que o usuário compreenda as funções e operações do sistema, incluindo funções específicas de alto nível. Gráficos ou tabelas devem ser incluídos, se apropriado.
6- Descrição das funções
Cada função específica do sistema é descrita. O seguinte pode ser incluído:
- Objetivo e uso da função. Relacionamentos com outras funções também devem ser adicionados.
- Inicialização da função, se aplicável.
- As opções de execução associadas à função e sua descrição.
- Descrição das entradas esperadas e seus resultados.
7- Preparação das funções de entrada
Esta seção inclui as entradas necessárias para o sistema ou produto funcionar corretamente.
8- Resultados
Os resultados esperados de cada função também devem ser incluídos. Esses resultados devem incluir gráficos, texto e tabelas que podem ajudar o usuário. Além disso, exemplos também são colocados.
9- Instruções de operação
A lista de processos relacionados às instruções de operação é fornecida aqui. Por exemplo, deve conter os procedimentos para entrar no sistema, se aplicável.
Este procedimento de inicialização deve descrever como definir o modo de operação necessário e como iniciar os parâmetros necessários para operar.
10- Manutenção
Esta seção inclui procedimentos para manter o sistema ou produto funcionando corretamente.
11- Erros
Esta seção deve atender a qualquer mensagem de erro que possa aparecer no sistema ou qualquer possível mau funcionamento do equipamento.
Por exemplo, você deve incluir uma lista de todas as mensagens de erro que podem aparecer, o que significam e como corrigi-las.
Exemplos de instruções
1- Instruções para montagem da cadeira
Segurança
Antes de usar as ferramentas, leia, entenda e siga as instruções de segurança de cada uma. Se você não entender, entre em contato com o fabricante.
Proteja seus olhos com óculos de segurança, seus ouvidos com isolamento e seus pulmões com um respirador ou máscara.
Plano de construção
Corte uma placa 2x4x8 de madeira, quatro placas 1x3x1 e três placas 5x3x2.
Monte a mesa de acordo com o diagrama e marque os pontos de união nos cantos com um lápis. Em seguida, prenda as peças com um prego e um martelo.
Os retângulos representam as variáveis observadas; as variáveis do fundo são refletidas como x.
Os círculos representam as variáveis latentes e as setas nas figuras representam as relações entre as variáveis.
Os recursos especiais incluem:
1- Análise individual ou em grupo.
2- Estratificação, probabilidades de seleção, pesos replicados e correções de população finita.
3- Estimativa máxima para os tipos de resultados.
Diagrammer
Ele pode ser usado para desenhar um diagrama de entrada. Para entrar nesta função, abra o menu de diagramação no Editor Mplus. Um conjunto de ferramentas de desenho é usado para fazer o diagrama.
Calculadora LTA
Probabilidades condicionais são calculadas, incluindo probabilidades de transição latente para diferentes valores. Ele pode ser usado escolhendo a Calculadora LTA no menu Mplus do Editor Mplus.
Referências
- Guia manual. Recuperado de statmodel.com
- Guia para construção de móveis para novatos (2017). Recuperado de sawsonskates.com
- Dicas para escrever manuais do usuário. Recuperado de userfocus.co.uk
- Guia de usuario. Recuperado de wikipedia.org
- Tutorial do guia do usuário. Recuperado de klariti.com