Técnicas de escrita manual

Escrever manuais técnicos ou de instrução exige conciso , linguagem e apresentação fácil de entender. Existem várias técnicas básicas que ajudam a criar esse tipo de apresentação. Cada ajuda a apresentar a informação de forma clara no manual. No entanto, o processo de escrever manuais eficazes começa com a investigação eficaz sobre o tema . Compreender o tema e , em seguida, usar essas técnicas para apresentar as informações de forma tão eficaz quanto possível. Introdução

A introdução define o manual. Explique que devem ler o documento e que não é destinado a , as informações incluídas e em que circunstâncias é útil . Para obter manuais de produtos, presumem que o leitor tenha adquirido o produto e está pronto para aprender a usá-lo. Mantenha a introdução curta para que o usuário chegue aos aspectos técnicos do Manual o mais rápido possível .
Contornos

Manuais Técnicos são muitas vezes dispostas em seções e subseções , que também fazer um esboço ideal . Liste todas as seções previstas para o manual e incluiu subseções detalhadas quando necessário . Não tenha medo de reorganizar as seções à medida que avança . Só porque você pensou tópico A primeira não significa que o leitor tem que bit de informação em primeiro lugar. A ordem final das seções devem refletir a progressão natural que o usuário fará ao mesmo tempo aprender o tema . Use um substantivo e verbo no cabeçalho da seção para definir o item e ação dentro da seção .
Ser ativo

Cada passo em um manual técnico instrui o leitor numa única acção que , quando realizado com outros passos , conduz a uma acção completa . Número dos passos ou ter gráficos "balas" para indicar os passos. Em algumas situações , os passos podem ser sub-etapas identificadas por números ou letras de acordo com as etapas básicas . Os escritores têm alguma discrição na forma como eles se identificam passos , mas deve ser consistente ao longo do manual.
Keep It
simples

Use a linguagem mais simples que transmite adequadamente a informação. Você não sabe quem vai ler o manual e como eles são versados ​​no jargão técnico sobre o tema . Evite altos níveis de detalhe ou detalhes não é necessário para transmitir as informações . As sentenças longas , mais de 20 palavras, tendem a desencorajar os leitores . Sentenças de menos de 10 palavras pode dar ao documento um som de cortar .
Ilustre o Tópico

Use fotografias, tabelas e gráficos para ilustrar o tópico. Estas imagens podem valer mais do que mil palavras, e tendem a chamar a atenção do leitor . Se as imagens gráficas não são possíveis , use frases descritivas . Exemplos verbais e ilustrações também permitem ao leitor visualizar o tópico .