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: Silly but important to me - another twist From:TecWriter1 -at- aol -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 01 Sep 2004 08:43:51 -0400
I was pondering this same question a little while ago...
In Joe's case, I definitely support the format of:
#. ACTION.
Result.
I like to see the action to be performed as the numbered step, and anything else as indented text below.
To expand on this, where do most of you think supporting/descriptive text for a procedure should go? In our equipment instructions, there is usually no "result" to report. It's
"remove the thingy" or
"insert the thingamajig into the whatchamacallit."
The supporting text might be something such as
"The thingy is located in the upper right corner of the control panel."
Options:
A. ACTION.
Supporting text.
B. ACTION. Supporting text.
And, in the rare care that there is a result to report, which format do you prefer to use or see?
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.