Learn how to write
Manuals that Help your Readers to Understand
This Technical Authoring Course has been running
since 2004, and has helped hundreds of people in 10
countries to write better User Manuals,
Maintenance Manuals, Software Help Guides, Standard
Operating Procedures, and so on.
I have been a full-time Technical Writer since
2000, but am now concentrating on training - I
want to pass on the best of what I know to
others, before I retire!
Many technical specialists have difficulty in "stepping
outside the box", and describing their system to
a completely new user, who may well be non-technical.
The result is documentation that may be technically
correct, but it's badly structured, readers can't
find the information easily, and it's so poorly
explained that they pick up the phone and call your
We teach you how to write Plain English
to your target readers - that means writing at
their level. It's a skill you can learn and use
for the rest of your careers.
Planning the Content
One common issue with documentation is the Content.
How much should you include? What can you safely
We teach you planning techniques that help to ensure that all
the necessary content is included, and anything
irrelevant is excluded. This keeps it concise.
Planning the Structure
A second common issue that people raise is about
the structure. What's the best sequence to arrange
the topics? Again, our planning techniques allow
this to be derived properly. We have long experience
freelance technical authors of working with our clients to derive the best structure
for your target reader groups.
Do your manuals have an Index-at-the-back?
A carefully-built Index allows users to find what
they want, quickly and easily. Most manuals don't
have an index: mine do. And it's the most useful
part of a manual. Think of the index as a sort of
search engine, which allows readers to find information
based on the thoughts and key words in their minds.
Our documentation specialists can do this for you.
I'll show you how to do it, quickly and
The index is automatically updated when new content
Learn the hidden secrets of
Most people write their manuals in MS Word so that,
when the job is finished, other staff can continue
to do the updates. So this Course has a one-hour module on Getting the Best
out of MS Word.
Technical Documentation Saves Money!
If your customers resort to phoning your Help
Desk instead of reading the documentation, then
this may mean that they don't find your manuals
and help guides easy to use.
For many companies, the average cost of a support
call is around £25-£30 per call. (Work out your
costs per call.) Then work out how much you can
save if you reduce your calls by 10 a month? 30
a month? 100 a month?
Learn how to write great Manuals and Help Guides,
so that your customers find information quickly, and then
understand the content easily. Then they can
get on with the job at hand, instead of calling
your Help Desk. In some companies, this has save
tens of thousands of pounds a year (if not
more), depending on your customer base and the quality
of existing documentation.
this one-day course at your premises, so that you can
learn the writing skills that benefit your
company. And you can use them for the rest of your
We also run courses for individuals at our
We check each person's particular training needs
in this subject area.
Where possible, we focus the training
material on these needs to suit each
allow for their capabilities and existing
We aim to motivate people and use interactive
may be able to tailor some of the syllabus to meet your requirements,