TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
Qronus Interactive Ltd.
Automated System Testing http://www.qronus-int.com
rebecca -at- qronus -dot- co -dot- il