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:AnnMacknz -at- AOL -dot- COM Date:Sat, 30 Nov 1996 15:19:48 -0500
In a message dated 96-11-29 05:22:30 EST, you write:
" I'm trying to outline the user guide for this product. Common sense and
experience tells me that I should list real world tasks, ie things the user
actually wants to do with this product and then the content of each task
will give examples of code (i.e. specific syntax structures) that will
achieve
this task. Can anyone suggest an alternative approach to planning a user
guide for this type of product?"
I think you are on the right track, Keith. You could set up chapters by the
main
type of project the user would attempt, then carefully choose good examples
within the main type that illustrate questions of syntax, etc. the user would
ask.
Depending upon the type of project, I usually have additional chapters on
troubleshooting
and maintenance, as well.
Ann Mackenzie
TekDoc - Technical Documentation, Inc.
