How to Design Training Documentation

Developing anything is a process, but the result is worth the effort.

Developing training documentation can be done in different ways, depending on your audience, product or service and time frame. Developing a training module for an inside sales force or online help documentation for a new software your company developed can be intimidating. A simple method to develop instructional material is to cover some familiar questions: who, what, why, where, when and how.

Instructions

1. Consider your audience. Determine who will use the documentation, how often they will use it and what type will be best for their learning and retention. Identify any potential challenges, such as a hostile audience or an audience with limited experience with your product or service.

2. Consider the product or service you are documenting. Solidify the main business and training objectives. Detail the budget and time frame you are working with and how broad or narrow a topic you will cover.

3. Choose a method or strategy. Training can be instructor-led in a classroom setting, an informational site such as a "wiki" page or a traditional printed guide booklet for perusal at the audience's convenience. Determine how often you need to update the material and how to accomplish the updating process.

4. Assign tasks. Creating training material requires a team. A team might be composed of technical writers, graphic designers, instructional designers, trainers, project managers and other professionals.

5. Develop the materials. Brainstorm, create outlines and storyboard the ideas. Break ideas or topics into manageable chunks or lessons. Search online or read about "instructional design principles" for guidance.

6. Write the documentation. Combine the objectives and ideas from your development sessions to form a well-rounded presentation of your product or service. Strike a balance between concise language and detailed instructions to effectively train your audience.

7. Prepare any necessary illustrations and design your material. The design determines a document's ease of use and information retention just as much as the actual words do.

8. Have an editor review the material to ensure a quality product. Test the documentation with potential clients to evaluate its effectiveness.

Tips & Warnings

• Another method of instructional training is known as the "ADDIE Process": analyze, design, develop, implement and evaluate. Search online for information on applying these principles to your instructional development.

References

• Info Pros Articles and Resources
• Preparing Instructional Objectives: A Critical Tool in the Development of Effective Instruction; Robert F. Mager; 1997

Resources

• Idaho State University, College of Education: ADDIE
• About e-Learning: Instructional Design Principles
• Efficiency in Learning: Evidence-Based Guidelines to Manage Cognitive Load; Ruth C. Clark; 2005
• The Architecture of Learning: Designing Instruction for the Learning Brain; Kevin D. Washburn; 2010
• Principles of Instructional Design; Robert M.Gagne; 1992