Não importa o quão engenhoso seja um inventor, programador ou racionalizador, às vezes suas criações simplesmente não podem ser usadas para o propósito pretendido. A razão para isso é o manual de instruções elaborado incorretamente ou sua ausência total. Mas mesmo inventores engenhosos às vezes escrevem tais instruções que, exceto por especialistas estreitos, ninguém pode ler esses artigos. Então, como você redige adequadamente um documento tão necessário?
É necessário
- - conhecimento de cem por cento do dispositivo ou produto de software para o qual o manual está sendo escrito;
- - conhecimentos no domínio da linguística;
- - habilidades de escrita.
Instruções
Passo 1
Um manual do usuário, ou seja, um manual de operação, é um documento elaborado para auxiliar seus usuários na utilização de um determinado sistema. Para compilar um manual do usuário, você precisa conhecer o sistema descrito cem por cento, mas olhe para ele pelos olhos de um aluno ignorante. Suponha que um manual do usuário foi escrito para um utilitário de software que ainda não possui análogos. Imagine que é a primeira vez que usa este programa. Por onde você começa? Qual é a primeira coisa a saber? Organize esse conhecimento em categorias de importância.
Passo 2
Ao dividir todas as informações sobre sua criação em grupos, você traçou um plano para escrever um manual do usuário. Comece descrevendo o trabalho em seu programa do zero, deixando por último os detalhes mais difíceis, como reprogramar recursos ou lidar com erros críticos. Nesta fase, você deve ter o conteúdo do manual do usuário pronto - uma das partes obrigatórias deste documento.
etapa 3
Se o manual que você está criando se destina ao uso em uma grande empresa, você deve prestar atenção aos padrões corporativos lá adotados. Por exemplo, em muitas empresas russas, manuais de usuário não são aceitos sem suporte ilustrativo, ou seja, imagens que explicam o que está escrito. Além do conteúdo, o manual do usuário deve conter outras partes obrigatórias: - Anotação, ou seja, uma explicação dos objetivos gerais do manual e do produto descrito; - uma introdução, que descreve os documentos relacionados ao manual do usuário e como para usar o manual; - seções que explicam o uso do produto em diferentes estágios de seu uso, por exemplo, primeiros passos, reparo ou manutenção; - seção de perguntas frequentes e respostas a elas; - glossário ou índice de assuntos.
Passo 4
Normalmente, um redator técnico está envolvido na criação de um manual do usuário - uma pessoa que possui todo o conhecimento necessário tanto no idioma quanto no produto que está sendo descrito. Como redator técnico sem treinamento, existem algumas regras a serem observadas. Em primeiro lugar, você não deve abusar de termos especiais que não sejam compreensíveis para um usuário comum. Em segundo lugar, cada termo usado deve ser detalhado e explicado. Em terceiro lugar, você precisa escrever da forma mais clara e concisa possível. Finalmente, um redator técnico deve ser capaz de ver seu próprio texto com os olhos de um usuário comum, a fim de ver as deficiências de seu próprio texto.
Etapa 5
É bom testar o texto acabado do manual do usuário na prática, oferecendo-o a uma pessoa que não teve nada a ver com o produto descrito. Por meio de esforços conjuntos, é possível eliminar todas as deficiências e armadilhas do documento.
