Escrevendo um manual de formação técnica

Pesquisar o seu público e seu nível de conforto com a tecnologia. Obviamente, um manual de treinamento técnico feito por um grupo de bibliotecários em seus 40s e 50s seria muito diferente do que o treinamento desenvolvido para recém-licenciados de um programa de ciência da computação. A familiaridade de seu público com a tecnologia vai afetar a linguagem que você usa e a própria estrutura do currículo do seu manual. Por exemplo, se você está escrevendo para um público de gurus da tecnologia, sua expectativa de seu nível de domínio depois de trabalhar através do manual será maior do que se você estivesse escrevendo para os neófitos de tecnologia.

Anote os objectivos de aprendizagem do manual de treinamento. Os objetivos de aprendizagem deve começar com verbos de ação fortes. Se você estiver escrevendo treinamento para software web design, por exemplo, dois objetivos de aprendizagem podem ser: 1. Entenda o que web design software X é usado para e articular suas limitações. 2. Concepção de uma página web básica usando software web design X, incluindo o estilo CSS folha de formatação, texto e imagens.

Delinear a estrutura do manual de treinamento. Decida se você pode trabalhar seus objetivos de aprendizagem em um único projeto que os alunos construir progressivamente ou uma série de mini-projetos que se relacionam uns com os outros no final. Um único projeto pode ser um manual ensinando os diferentes aspectos do software de web design para criar uma página web básica. Uma série de projectos pode ser baseado em como usar o software design suite onde os usuários editar uma foto, criar um layout de brochura e, em seguida, trazer a foto editada na brochura para completar o projeto.

Quebrar o seu conteúdo de treinamento em aulas individuais. Você deve ser capaz de atribuir alguns objetivos de aprendizagem para cada lição que você definir. Gravar estes objectivos de aprendizagem em forma de ponto no início de cada capítulo. Eles ajudam os usuários a entender o que eles podem esperar e direcionar seus esforços de escrita durante o processo de elaboração.

Projecto de seus capítulos de aula. Use títulos para dividir processos menores dentro de aulas individuais. Tente fornecer apenas uma direção por passo, e começar todas as direções com um verbo de ação claro. Ao decidir como detalhado a passo deve ser, considere o seu público. Ao tentar decidiu se vai incluir algo em uma lição ou não, rever os objectivos de aprendizagem que você escreveu. incluir apenas o conteúdo que ajuda a satisfazer um objetivo de aprendizado.

Escrever lição resumos no final de seus capítulos. Incluem gráficos de referência rápida para os conceitos que os alunos pode querer olhar mais tarde. Por exemplo, se você introduzir 10 novas funções em uma lição, incluí-los todos em uma tabela de referência rápida para que os usuários não têm que percorrer todo o capítulo de uma sinopse do que aprenderam.

Teste o seu manual de treinamento dos participantes imparciais, de preferência aqueles que refletem o seu público no mundo real. Trabalhar com um assunto de cada vez, pedindo o seu público a pensar em voz alta como eles trabalham através de seu programa de treinamento. Observe o seu progresso, tomando notas enquanto se movem para a frente. Cathrine Whitaker, membro da Sociedade de Comunicação Técnica em San Diego, incentiva escritores para procurar problemas com a consistência de instruções, relevância e eficácia. Certifique-se que os usuários de teste compreender suas instruções, não são paralisados ​​por detalhes ou uma superabundância de informações em falta, e não são confundidos por direções conflitantes.

Edite seu manual, consultar as notas de suas sessões de testes como o seu trabalho. Polir sua ortografia, gramática e estrutura das frases.