Writing’s not easy. To put that another way, and use the words of Ernest Hemingway, “Easy writing makes hard reading.”
As a writer, you want to do the difficult work so your reader doesn’t have to. And if it’s true that all types of writing are difficult, it’s also true that each type of writing presents its own challenges. That’s definitely the case when it comes to writing instructional or training materials. So, we’ve created a list of tips and resources for you.
We hope you find these helfpul; feel free to contribute your own ideas in the comments section below.
Convergence Training is a training solutions provider with many libraries of off-the-shelf e-learning courses for job training, a series of learning management systems (LMSs) for administering training, custom training solutions, and more. If you’d like some help with your own training program, contact us.
And don’t forget to download our free guide to Effective Manufacturing Training.
General Writing Tips for Training Materials
The following tips apply to any kind of training materials. Things people will read, the narrated script of an e-learning course, and more.
Know your audience
Every aspect of writing and creating training materials begins with knowing your audience.
Write for your audience
Once you’ve learned about your audience, keep their needs and characteristics in mind while writing for them.
Write to your audience
Use the second person and refer to your audience as “you.”
Use conversational language
Write the same way your audience talks. A lot of people fall into a formal style when they write training materials, even though it’s harder for the audience to read. Avoid that. But remember, being conversational doesn’t mean you should include lots of slang or potentially offensive language.
People are “hard-wired” to enjoy and remember stories. Don’t just tell someone something–tell them a story that tells them something.
Put people in scenarios
People are more interested in something that’s happening to someone else or to themselves. Place them within a learning scenario.
Use short words instead of big words
When possible, avoid using big words when a shorter, more familiar word will do. For example, write “buy” instead of “purchase” and “person” instead of “individual.” Here’s a good article about using short words.
Use short and simple sentences
Long sentences may confuse your reader. This is even more true if the sentence structure is complex. Here’s a good resource about simple and complex sentences.
Keep the piece short
Just write about the important stuff your learners need to know. Don’t add more material simply because you think it’s interesting. Remember that everything you write should be focused on a learning objective.
Break your piece up into smaller “chunks”
Break your content into smaller parts, or “chunks.” That’s because most people can only keep 4-7 bits of information in their short-term memory without losing the information. Here’s a fuller explanation of chunking your instructional material.
Format your “chunks” visually for easy reading
Your computer gives you tons of tools to format those little chunks of information–use ’em. Use headers to explain what each chunk covers, and put them in bold font. Use bulleted lists and tables to break information down so it’s easier to scan and quickly understand. Present information in parallel structures. Here’s a fuller look at formatting written training materials to increase training effectiveness.
Write at an appropriate reading level
The average American reads at about a 7th or 8th grade level. So you should generally keep your writing at that level, too. If you’re writing for doctors, attorneys, and engineers, write at a higher level. If you’re writing for people who do not speak English as their first language, write at a lower level. Most word processors, including Microsoft Word, have a tool to analyze the readability of your material.
Don’t explain things your audience already knows
Don’t insult, bore, and turn off your audience by explaining things they already know. For example, if your goal is to train them how to make a common household item, don’t start by defining the item. Here’s more about how to keep material that’s too basic out of your training materials.
Don’t explain things your audience doesn’t need to know
Again, if you’re training your audience to make a common household item, your training probably shouldn’t start with a 15-minute history of that item’s development over the past three centuries.
Avoid specialized language (“jargon”) when possible
Every field has its own specialized language known as jargon. Jargon can be a useful type of shorthand or code for experts, but non-experts typically don’t understand what it means. When you can, avoid using jargon.
If you must use jargon, define it
If it’s necessary to use jargon, make sure you explain it to your audience.
Write in the active sense
Active sentences tend to be shorter and less confusing. Passive sentences tend to be longer and more confusing. Stay active, my friend. Here’s a good resource on writing in the active sense.
Use strong, descriptive verbs
Avoid using forms of “to be.” Using forms of to be, such as “is,” “are,” and “were,” is not as memorable as using strong and descriptive verbs. Here’s a good game to help you recognize stronger verbs.
Be consistent with your terms
If you’re identified something as a “widget” in your introduction, keep calling it a widget throughout. Don’t suddenly call it a “whatchamacallit” in a later section.
Be careful with pronouns
When you refer to a noun by its name (example: refrigerator), everyone knows what you’re talking about. If you begin using pronouns (example: it) instead, though, you may confuse people. Consider cutting down on your use of pronouns, and be careful to avoid confusion when you do use them.
Don’t let your subject matter expert (SME) do the writing
Subject matter experts, or SMEs, are bright people. They’re passionate experts on the topic they’re describing. This makes them prone to violate many of the rules we just discussed—even if they DO happen to be good writers, which isn’t always true. Here are some more tips on working with SMEs.
Proofread several times
Always proofread your own materials. Do it several times. Read it aloud to yourself–this can really help. Don’t just rely on your spell-checker (but yes, use it too).
Read it out loud to yourself
Careful readers may be saying “Hey, you just said that above.” And that’s true. But it bears stating again, plus several readers added that comment after reading this article (see comments below, for example), so I’m thinking maybe people missed it.
Have someone else review your writing
Even the best writers benefit from having someone else read their stuff to point out what’s clunky or confusing.
Following the rules above should go far to get you writing effective training materials. Of course, the more you learn the better you’ll be, so we’ve collected some additional resources for you below.
Writing Rules & Style Guides
This list of resources that will help you with any type of writing.
The classic high school style guide by Strunk & White that’s still relevant in all fields today.
Probably the leading style guide.
More relevant for journalists, but still useful.
A great resource for all things writing-related.
A fun and informative online guide to grammar.
Or any good dictionary and thesaurus. This one is online and free, and we like their occasional informative videos.
Helpful if you’re writing about software.
More Tips for Writing Instructional & Training Material
Next, a list of resources to help you write instructional and training material. Obviously, this is nowhere near complete, but it’s still helpful.
“10 Types of Writing for eLearning” by Connie Malamed
A nice overview of the different styles of writing required in e-learning.
“8 Tips for Better Writing,” by Connie Malamed
8 simple-yet-effective tips from a journalist.
“Less Text, More Learning” by Cathy Moore
A nice explanation of why fewer words = more learning.
“Why You Do Not Want to Sound Like a Robot” by Cathy Moore
An argument for conversational language—including contractions!
“How to Recognize Elearning Bloat” by Cathy Moore
How to know when you’re writing too much.
“How to Get Everyone to Write Like Ernest Hemingway” by Cathy Moore
Good arguments in favor of lower reading levels.
“No More Spilled Ink: Writing for Instructional Design” by Connie Malamed
A great overview of writing issues for instructional designers.
“Writing Styles for eLearning Narration” by Tim Slade
A thoughtful, helpful discussion of writing for e-learning.
“Why You Need Scenario-Based e-Learning” by Connie Malamed
A podcast during which one of my favorite instructional designers, Connie Malamed, discusses the importance of scenarios in e-learning with another great instructional designer, Ruth Colvin Clark. Not as directly related to writing style as the other comments and links above, but worth your time nonetheless.
“How to Write Compelling Stories” by Connie Malamed
Another podcast hosted by Connie Malamed. In this one, she discussed the importance of storytelling in instructional materials and talks with noted author and storytelling expert Lisa Cron, author of Wired for Story.
So, what about you? Have any good tips or resources for writing instructional or training materials? If so, we’d love to see them below in the comments section.
How to Write Learning Objectives
All the basics about writing learning objectives for training materials.