Como escrever Manuais Técnicos

Uma explosão em tecnologia tem alimentado a necessidade de manuais técnicos , mas a maioria são ou tão difícil ou tão chato de ler que os usuários atirá-los de lado e acabam chamando o centro de suporte técnico da empresa. Na verdade, os manuais têm uma reputação tão ruim que muitos consumidores simplesmente ligar para a linha de ajuda do produto antes mesmo de consultar o manual. Se você pode escrever um manual técnico que ajuda o usuário a realizar sua tarefa em linguagem clara e fácil de entender , você pode apenas chegar aos consumidores para lê-lo e salvar o centro de suporte técnico mais uma chamada da sua empresa para obter ajuda. Instruções

1

entrevistar os especialistas no assunto (PME) para descobrir ” a verdadeira história ” por trás do produto . Quando eles explicam como o produto funciona em termos técnicos, pedir-lhes para explicar o que isso significa para o consumidor. O consumidor compra a tecnologia para ajudá-los a fazer alguma coisa. O seu manual precisa ajudá-los a usar sua tecnologia para fazer isso alguma coisa. Eles não se preocupam com a engenharia avançada por trás dele.

2

Explique o problema que está sendo resolvido . Muitos manuais técnicos gastar páginas e páginas explicando todas as características técnicas do seu produto , negligenciando a explicar por que um consumidor iria querer usar esses recursos. Mágico por que o consumidor deve se preocupar com uma característica particular. Por exemplo, este recurso novo e melhorado permite que você verifique seu e-mail enquanto você estiver navegando na Internet — e é muito mais fácil de usar do que o recurso de idade.

3

Escrever para ajudar o consumidor a realizar uma actividade . Faça as explicações curtas e simples e incluem ilustrações. Lembre-se , as pessoas não querem ler manuais; eles querem usar o produto para fazer a sua atividade.

4

Escreva em um estilo simples e coloquial. Explique a atividade como se estivesse falando com seu melhor amigo. Seu tom deve soar algo como isto: “Esta é uma característica muito grande Deixe-me dizer-lhe porquê Veja o que você pode fazer com ele . . “.

5

Tente criar ” aha ! ” momentos para o utilizador , como em “Ah! Isso é como você fazer isso! ”

6

Edite o seu manual para remover seções excessivamente detalhado ou técnicos. Certifique-se de que a sua escrita é clara , simples e fácil de entender. Executá-lo por um amigo ou colega que tem pouca experiência com o produto. Peça-lhe para fazer os passos necessários e se é fácil de seguir.

7

torná-lo agradável de ler. Mantenha a sua luz escrita e conversação e não tenha medo de adicionar um pouco de humor ou uma anedota engraçada. Quanto mais ” divertido ” o manual é para ler, os consumidores mais propensos vai lê-lo — e menos provável será que eles vão ligar para a linha de ajuda do produto .