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: Getting Started guides From:"Burns, Nancy" <nburns -at- BREAULT -dot- COM> Date:Wed, 3 Feb 1999 16:14:50 -0700
-----Original Message-----
From: Lynette Petendree <Lynette_Petendree -at- INSTINET -dot- COM>
Date: Wednesday, February 03, 1999 7:25 AM
A friend of mine has been moved ...to writing Getting Started guides and
tutorials (in the Marketing group). I ...was hoping that some of you can
recommend books, examples, websites etc., that she could refer to. ...
---------------------------
Lynnette,
Here's a brief description of Getting Started manuals, based on my own
experience. There are likely lots of other topics to include that I have not
mentioned. I also added a statement about Reference Manuals:
Getting Started manuals are generally brief (pamphlet size) and typically
include information for users that they will need BEFORE installing the
program. Topics might include contents of the shipment, installation
instructions, hardware requirements, overview of the program's purpose and
philosophy (not instructions on how to use it), an introductory tutorial,
resources (such as online Help, Customer Service, contact information),
other related company products. As another poster mentioned, consider this
manual a marketing tool.
By contrast, User Guides are instructional. They walk users through a task
or operation by describing what to do in the actual screens or dialog boxes
via screen shots and step-by-step instructions. They also might define all
the menu items, toolbars, and error messages.
For command-oriented applications, Reference Guides alphabetically list all
the commands. Command topics usually include a brief definition of their
purpose, command syntax, options, and remarks.
It's not easy finding samples of these manuals since most companies consider
their documentation proprietary information. STC (Society for Technical
Communication) offers annual competitions around the country, and sometimes
the winning submissions can be viewed at chapter meetings.
Technical communication books on how to write user documentation may be a
good source. Try doing a search at amazon.com or barnesandnoble.com to
titles. Visit http://www.raycomm.com/techwhirl/archives.htm
