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: a question about writing instructions From:"Gerry Loiacono" <gerry -dot- loiacono -at- aztec-it -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 7 Feb 2003 00:46:50 +1000
It depends on how it is perceived the users will use the documentation.
If it is perceived that users will want a narrative on all the functionality
available in a particular screen, the example below is perfect.
If, however, the users will want to find information about a specific
activity (like how to search, for example), then the information should be
broken out into separate sections for each activity.
Regards,
Gerry Loiacono
Aztec IT Services
www.aztec-it.com.au
www.aztec-it.com.au/twblog (tech writing web log)
-----Original Message-----
From: bounce-techwr-l-115247 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-115247 -at- lists -dot- raycomm -dot- com]On Behalf Of Becca
Price
Sent: Friday, 7 February 2003 12:05 AM
To: TECHWR-L
Subject: a question about writing instructions
I recently started in a new position where the house style is to
not write out instructions as steps, but rather in narrative
form. That is, rather than having step 1, step 2, etc, an
instruction might read (under a header like "Using the XYZ
Screen"): "To add an item to the data base, enter the specific
information and press Add. To locate an item already in the
database, enter any information you may have, and press Search.
If more than one item matches your criteria, you will see..."
You get the idea.
This is a made-up situation; no comments about the design of the
mythical page or database or use thereof, please! My question is
strictly about format.
Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l
---
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.
