What is a good user guide?

Anyone can write 'Enter your name in the Name field and click Continue to continue'. However, that type of documentation is usually useless.

A good user guide helps people to use software. A user guide does not need to explain things that are clear. However, what is 'clear' is dependent on the knowledge of the people who use the software. TechScribe deals with the difficult problems. If software is simple, the software does not need much explanation. Sometimes, software is difficult to use for the following reasons:

• The subject is complex.
• The procedures that people do are complex.
• Complex connections exist between different software modules.

Therefore, before we produce a user guide, we learn about your software and we ask you many questions. After we understand your software, we can design and produce a user guide.

© TechScribe, UK.