|
User
Manuals
These are
the easiest to read and use, and are designed for the non-technical
reader who wants to start with "how to switch it on" and use
it. It may even show where the “On” switch is. (Don’t laugh
– people ask!)
When designed
for software packages, these guides are designed to provide
the user all the information they need to use the software
to perform a range of tasks. A well designed user guide can:
- reduce
support calls
- help
new staff perform daily tasks
- help
experienced staff perform infrequent tasks
- standardise
work practises.
These are
for the more technical readers, often at graduate level, and
may cover the complete setup of a software system, for example.
These are
for Help Desk staff, who need to know how the overall system
should be set up, and including total support information.
This normally includes Technical and User Manual content.
These can
be written for your training staff, and provide you with material
for training other users of equipment or systems; or they
may just complement your own Customer Training process.
Working
one-to-one with clients allows close cooperation, so when
you need alternatives, we design accordingly.
| Reference
Manuals (Programmer Bibles) |
|
These are
typically comprehensive manuals which the user can use to
check for information when required. They are fully indexed
and cross-referenced.
If your
product is so complicated that a third-party specialist takes
care of the maintenance on your behalf, then this type of
manual is ideal. For portability and ease of use, these typically
large manuals can also be generated in pdf format so they
can be accessed on-line (via an intranet, on-line help or
web site), or from a CD.
As your
company grows, you will need to document your standards and
procedures. They bring together the knowledge within your
company, help new staff learn company procedures, and help
ensure everyone is working to the same standards. Basically,
they are an ideal way to underpin your internal quality systems.
Technical
staff, while highly-skilled and very knowledgeable, frequently
have problems putting their thoughts down on paper.
We can make
sense of the technical jargon and scribbled notes (including
beer mats!) to produce your specifications.
These documents
are primarily used by software houses and are aimed at internal
staff and expert-end users. They describe new and advanced
functionality at a high level in new software releases.
Ideal for
anyone operating specialist equipment, in the home or commercial
premises. Clear instructions, supported by illustrations (and
photographs where appropriate), with trouble shooting tips.
These instructions can be particularly useful for newly trained
staff. Good operating instructions can enhance your product
and your company's reputation.
If you supply
a flat-packed product, these are vital for your customers.
They take the customer through the task step-by-step in a
visual format. They also include a check list of components.
Overviews
are designed to support your sales literature and give an
in-depth view of your product. They enable your clients, both
new and established, to make informed decisions in conjunction
with input from your staff.
Your company
probably has at least one member of staff that all the others
go to for knowledge and advice about one particular aspect
of your business operations, products or services. A series
of skills books can capture this invaluable knowledge so that
it can be shared by everyone while reducing the pressures
on your expert staff. These books can also be used to drive
internal training sessions.
Prior to
going live with a new computer system, it is always advisable
to run your own tests on a test system. It is not enough to
simply enter a few sales orders. A series of carefully designed
test scripts will ensure your staff puts the system through
its paces, highlighting possible problems before the go-live
date.
These interactive
solutions combine text, graphics and maybe even sound for
presentations, demonstrations and tutorials.
| Document
Redesign ("Cosmetic Surgery") |
|
Maybe you
have all the right documentation but it is old fashioned and
looking dated. Maybe it doesn't completely cover everything.
Maybe you just need to change the delivery format, for example,
convert your paper documentation to on-line help. We can analyse
your existing documentation to help you achieve the look,
feel and content you need.
|
