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.
I think you're right. I also use bullets to indicate a single step. The bullet
is pretty much an industry standard.
Keep in mind that just because a reviewer asks if you can do something, it
doesn't mean they are right and you have to do it. I sometimes argue against
reviewer comments. I treat them as suggestions, not orders, unless they are
commenting on something I know nothing about, or I've been told that one of
them is the ultimate owner of the document and I have to do it their way.
After all, we're the professional writers and experts that should save them
from allowing errors in grammar and usage to enter their manuals, should they
try to insert them. They know their product, subject, or whatever, but that
doesn't mean they know how to be a good technical writer.
Lin
linlaurie -at- msn -dot- com
----------
From: Technical Writers List; for all Technical Communication issues on
behalf of Christopher Knight
Sent: Thursday, July 31, 1997 11:40 PM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Single-step procedures
Further to the posting earlier about numbers-for-steps and
bullets-for-lists, my practice is to use a bullet for a procedure
with only one step. A reviewer has just asked me to change this
to a number 1 "for consistency". I figure a number 1 implies
more than one step. What do you-all think?
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
