Scribd
Upload
173 views11 pages

Writing A Manual: How To Write An Effective Instructional Manual

This document provides tips for writing effective instruction manuals. It recommends that authors (1) become experts on the product or process by using it themselves before writing, (2) interview actual experts to ensure technical accuracy, and (3) write concisely using short sentences, active voice, and plain language while keeping the intended audience in mind. The goal is to provide only the most essential information readers will understand and use within seconds of scanning the text or manual. Diagrams, photographs and an organized structure can aid comprehension.

Uploaded by

Aadesh Kumar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
173 views11 pages

Writing A Manual: How To Write An Effective Instructional Manual

This document provides tips for writing effective instruction manuals. It recommends that authors (1) become experts on the product or process by using it themselves before writing, (2) interview actual experts to ensure technical accuracy, and (3) write concisely using short sentences, active voice, and plain language while keeping the intended audience in mind. The goal is to provide only the most essential information readers will understand and use within seconds of scanning the text or manual. Diagrams, photographs and an organized structure can aid comprehension.

Uploaded by

Aadesh Kumar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd

WRITING A

MANUAL
How to write an effective instructional manual
Look Before YOU Write-Know the
product and process
■ The first requirement for tech writing is knowledge.
■ You can’t teach someone how to do something until you’ve done it
yourself.
■ If you’re writing assembly instructions, put the product together.
■ If you’re writing about software, use the program.
■ If you’re writing a product manual, you should know the product inside
and out.
■ Use it, take it apart, figure out how it works and what it’s meant to do.
Look Before YOU Write- Talk to the
experts

■ If you’re not an expert at what you’re writing about, talk to someone who
is.
■ Chat with the developers, technicians, or designers.
■ Ask them to give you a walkthrough of the product, process, or software.
■ Ask them how it’s made, how it’s done, and why things are the way they
are.
■ Then, keep asking if you need more help.
Being concise
■ That rule applies doubly if you’re writing for the internet. Chrome,
Safari, and Firefox are all called web browsers instead of web readers for
a reason.
■ People don’t read web pages.
■ They scan, hunting and pecking for words and phrases that they find
pertinent.
■ The average person spends just seconds on a web page, reading only
about 20% of the text.
■ The more concise you are, the more information readers actually read.
■ Even paper manuals aren’t “well read,” in the classic sense.
How to Concise Things?

Paragraphs:

■ Lead with the most important information FIRST!


■ Get rid of unimportant and unnecessary words.
■ Always…. Check the word count. Always.
Sentences:
■ Short sentences are your friend, eg;
Assemble small 90° adapter fitting to outlet port of filter base
and orient so that free end of fitting will point toward
backhoe and angled about 30° upward from horizontal.

Attach the small 90° adapter fitting to the port of the filter base.
The free end of the fitting should point toward the backhoe.
Angle the fitting about 30° upward of horizontal.
■ Dump empty words that hold no meaning or importance in
terms of your instructions. Eg; but, if, in the event of, etc
■ Reduce the amount of ‘to-be verbs’. Eg;
Here’s an example from a car assembly manual: “If you damage
any parts, it will probably be because they were either not stored
properly or, the wrong tool was used to install them.”
That’s three passive verbs in the same sentence. We eliminated
the lazy verbs for our revision: “Storing a tool improperly or
using the wrong installation tools can lead to damaged parts.“
■ Use passive voice strategically.
■ Using passive voice doesn’t make you a bad person. Just use
passives purposefully.
■ Unless you have a reason for using passive voice, switch to
active voice.
Here’s an example of passive voice from a user manual: “A
booster seat should be used to obtain proper seat belt fit.”
Crystal Clarity
■ Use plain language
■ Avoid unnecessary jargons
■ Don’t turn verbs into noun
■ Articles are not the enemy, use them wisely
■ Have a second novice reader
■ Don’t use vague words like slightly, quiet, sort of, pretty.
Audience, audience and audience!!!
■ When writing keep your readers in mind
■ Know what they might know and might not know
■ Play with their schema
■ Inform them, don’t tell them
■ Use pictures and photographs, it helps make understanding and explaining easier,
especially with step by step instructions. Along with diagrams.
■ Organize the content
■ Proof read it and check with legalisation
Source

https://www.dozuki.com/Tech_Writing

You might also like