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 manual: contents? From:DWeber <dweber -at- ISDLINK1 -dot- HISD -dot- HARRIS -dot- COM> Date:Fri, 17 Jan 1997 11:24:48 EST
Getting started manuals usually contain:
Introduction
Installation (software requirements, etc)
How to access the application
Description of General commands (how to...save, access on-line help,
exit, etc)
Accessing Commands (how to manipulate the mouse, toolbars, pull-down
menus, cursor commands, dialog boxes, etc)
Interface Description (using the mouse, manipulate objects, other
items relevent to that software)
Setting Preferences (if their is an option menu (change user name,
setting display window, etc)
These are just a few ideas to maybe help you get started. Of course
you must tailor your contents for the application) For industry
standards....observe other manuals for style/content ideas.
______________________________ Reply Separator _________________________________
Subject: Getting Started manual: contents?
Author: Mark Pundurs <mark -at- INSTALLSHIELD -dot- COM> at smtp
Date: 1/17/97 11:13 AM
What should a Getting Started software manual contain?
And are there any 'industry standards' for a Getting Started manual?
Thanks,
Mark
**************************************************************************
Mark Pundurs - Lead Technical Writer
mark -at- installshield -dot- com
Phone: 847-619-7636, Fax: 847-240-9120
InstallShield Corp.
900 National Parkway, Suite 125
Schaumburg, IL 60173-5108 USA http://www.installshield.com
International Editions of InstallShield3 now Available!
**************************************************************************
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
