Instruction Manuals for Equipment or Software
I have written a vast range of Scientific, Commercial and Technical
documentation in the form of Manuals, Help Guides and Handbooks.
Instruction Manuals for Printing or PDF
Documentation such as Instruction Manuals for
and Software applications, for
Operating Procedures, and so on.
Plain English: The readers need to understand
what they read, so we specialise in writing that
is clear, to the point, thorough, and in the
Plain English for the target reader
Target reader groups: Each manual is targeted at its reader
groups, so you need to know who these people
are, and what they need to know. Will the manuals
need to address many reader groups, or
only one? Will they be non-technical? Fitters? Technicians?
Graduates? IT professionals? Engineers? Clerical
staff? Reception desk? Are they computer
Content: Good manuals normally
Table of Contents
descriptions, instructions, etc
Relevant Diagrams / Photographs
Screen images (for
index-at-the-back to help people
find the information.
Training Course outlines,
I firmly believe in "Plain English Plus", based on my research into
best practices and resources from
I write for the end reader, and often the style
is very different from the way technical
designers and developers would write. (For
example, programmers often find it hard to
describe their software to a new, non-technical
I also avoid "jargon", unless it is the normal
everyday language of that target reader group.
What kinds of manuals?
These are often designed for the layman or
non-technical reader, who wants to start with
"How do I switch it on?"
Aimed at the more technical readers, often
graduates, and may cover subjects like the
complete setup of a software system, an X-Ray
scanning machinem, medical equipment, and so on.
These would be a resource for Help Desk or
Contact Centre staff, who need to know how the
overall system should be set up. Often it
includes full support information. This would
normally include Technical and User Manual
These might be written for your training
staff, or for your customers' trainers on site.
They include material for training other users
of the equipment or systems; or they may just
complement your own Customer Training process.
engaged Philip to rework a user manual for one
of the machines we manufacture - the
"Philip's attention to detail and highly
methodical approach have produced a superb,
user-friendly document which is a quantum leap
on what we had before."
Hugh Freer -
International Sales Manager -
To read more about the Training Course Outline, follow the link
on the Home Page.