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.
In my experience, a Quick Start Guide is a multi-page document containing
both process and function information (a miniature version of the user
guide) covering only those things that a user needs to launch the system,
log in, and perform the most immediate and basic tasks. It also helps
identify the systems' major feature, GUI familiarization, contact
information, and references to place to go for more detailed help.
A laminated card or set of cards that contain quick refresher information of
oft-repeated tasks is generally referred to as a Quick Reference Card or (by
trainers and some admins) as a "job aid."
-Ed Gregory
-----Original Message-----
From: bounce-techwr-l-94027 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-94027 -at- lists -dot- raycomm -dot- com]On Behalf Of Ruby Isaacs
Sent: Monday, April 08, 2002 2:42 PM
To: TECHWR-L
Subject: Quick start guide: electronic or paper?
For a Web-based application, would you publish a quick start guide as the
electronic home page or on paper?
As the technical editor, for this small contract, my deliverables are an
approximately 150-page user guide and a quick start guide.
The over-worked programmer has posted general steps on the home page. When I
expand the procedures and test them, I need to print the page to continue
past the second step in most of the procedures. However, it is convenient to
know that a user can quickly access the home page instead of searching for a
quick start guide which is only on paper.
Of course, the GUI is continually changes so I think the programmer will
re-write the procedures as he updates the GUI.
Please advise.
Thanks.
Ruby Isaacs
www.quendi.ca
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
