Re: Writing User Guide for code

Subject: Re: Writing User Guide for code
From: Rebecca Phillips <Rebecca -at- QRONUS -dot- CO -dot- IL>
Date: Sun, 1 Dec 1996 10:20:04 +0200

>>I am planning a set of documentation for a product which is code-based
>>rather than GUI-based. <generous snip>
>>Can anyone suggest an alternative approach to planning a user guide for
>>this type of product?

I would suggest that in addition to a task-based user guide, you have a
reference manual and/or a quick reference guide. The reference manual
would simply be an alphabetical reference of possible commands. If not,
it might be topic-based in a way that complements the user guide.
Alternately, you might consider a quick reference. This would be a
little leaflet containing the most common commands and syntax, and maybe
a brief explanation. Our product has both a reference guide and a quick
reference. The reference guide includes syntax, examples, and a long
explanation of each command. The quick reference guide gives syntax and
a one-line explanation of each command. The users love the handy
quick-reference once they have gotten a thorough understanding of how to
use the product.


Rebecca M. Phillips
Documentation Manager
Qronus Interactive Ltd.
Automated System Testing
rebecca -at- qronus -dot- co -dot- il

Previous by Author: Re: flat fee question...
Next by Author: Re: Readability of extended list items?
Previous by Thread: Re: flat fee question...
Next by Thread: Writing User Guide for Code

What this post helpful? Share it with friends and colleagues:

Sponsored Ads