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 often useless.
A good user guide helps people to use software. It does not need to explain the obvious. However, what is 'obvious' depends on the skills and experiences of the people who use your software. At TechScribe, we deal with the difficult problems. You see, if software is intuitive, it does not need much explanation. Sometimes, no matter how intuitive the interface is, the software is difficult to use. Not because there is anything wrong with the interface, but rather, because:
- The subject matter is complex
- The procedures that people do are complex
- Complex relationships exist between different software modules.
Therefore, before we produce a user guide, we learn about your software and we ask you many questions. When we understand your software, we can design and produce a user guide.