Douglas Krantz - Technical Writer - Describing How It Works
Go to the Home Page of Douglas Krantz - Technical Writer
Read the Articles
Find out what Douglas Krantz Writer is all about
Douglas Krantzs Privacy Policy
Contact Douglas Krantz
Go to the Fire Alarm Home Page of Douglas Krantz -- Describing How It Works

Writing

A Manual is a Set of How-To Instructions
Douglas Krantz -- Fire Alarm Engineering Technician, Electronic Designer, Electronic Technician, Writer






What is an Instruction Manual?

By Douglas Krantz

Explaining the method used to accomplish a project, an instruction manual is a one-way communication.

Explanations

The instructions can explain how to mount a picture frame; the instructions can explain how to operate the food blender; the instructions can explain how to fix a broken motorcycle; the instructions can even explain how to manually run a space station.

Always though, an instruction manual is the communication provided by someone who knows how a project should be done to someone who needs to know how to do it.

Cover-to-Cover

Few people ever read a manual cover-to-cover. To many people, referring to the manual is thought-of as the last resort. On the other hand, especially when the project is very complicated or dangerous. The instructions referred to in the manual are the first thing sought by the user.

Depending on what information is needed, though, each user will read different sections of a manual. The reader will use the manual:
  • For how-to assemble instructions
  • For general information
  • As a theory of operation
  • For operating procedures
  • For a system summary
  • As a technical repair reference
  • As a specification reference
  • As a safety precaution
  • As a parts source
  • As a checklist
  • As a list of requirements
  • As a list of permissions
  • For training instructions
  • To answer frequently asked questions
  • For information about capabilities
  • For reporting and documentation forms
  • For legal notices
  • Etc.
Because what the user is going to read is never known, most instruction manuals include many of these sections.

Varied Audience

Each person using an instruction manual has different background knowledge so a manual has to be written to a varied audience:
  • Those that don't know
  • Those that don't know they don't know
  • Those who need some help understanding
  • Those who are just interested
  • Those who just need the confidence
  • Etc.

Multiple Explanations

A manual should contain more than one explanation because each person reading the manual gains understanding through different channels of learning:
  • To understand, one person may need diagrams
  • To understand, one person may need pictures
  • To understand, one person may need step-by-step instructions
  • To understand, one person may need an essay explaining the steps

Was this
helpful?
Yes   No

To some people, how to accomplish a project is intuitive; other people need some explanation. Background knowledge may be all that's needed; then again, background knowledge may not be sufficient. Some people just need an exploded view; some people need to be told in words.

If the project is complicated, the more methods of showing how to get the job done, the greater number of people will understand.

The Manual Bottom Line

Being given from someone that knows to someone that doesn't know, a manual is a set of instructions explaining how to accomplish something.






Advertisement


Douglas Krantz

Content Writer
Describing How It Works
writer@douglaskrantz.com
Text
612/986-4210

View Douglas Krantz's profile on LinkedIn



Ask
The
Technician

Readers Questions


Articles

Keywords are for the Reader
Always keep in mind -- webpages are not for the search engine, webpages are for the reader; keywords are not for the search engine, keywords are for the reader.

Marketing - Outbound vs Inbound
Simplistically speaking, going through the crowds in the marketplace, picking out potential buyers, and showing them the wares is marketing. Here, the seller is picking out who to talk to.

SEO (Search Engine Optimization) Isn't For Search Engines
Search engines don't care about any company's web site; there are far too many web sites. Search engines aren't giving away cash, credit, or even the ability for anyone to stay in business; that's not why they're there.

Use Common Words
The words and phrases we use for everyday communications are shorthand for word meanings. We say "sweep the floor," but what we really mean is

Call to Action (CTA)
The salesman's greeting starts out the conversation with "How's it going?", this requires an answer. The server at a restaurant stops by in the middle of the meal and says

Content That's Worth Something
For content to be worth something, it has to attract the attention of the casual reader. It also has to be interesting enough to keep the casual reader there.