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: How would you From:Chuck Martin <cmartin -at- SEEKERSOFT -dot- COM> Date:Wed, 27 Aug 1997 14:33:18 -0700
Right off the top of my head I see two issues:
1. How high will the numbering go? Will the numbering change as the fixes
become irrelevant? Besides, do you really want to have fix numbers into the
hundreds or thousands, especially that users will see?
2. When discussing the fixes, not everyone will have the document. Why not
just say what the fix is? Why do they have to be mapped to a number when
you can just talk about the fix itself? It's an unnecessary layer.
At 02:04 PM 8/27/97 MST, you wrote:
> I have a question for you all. I was going over a section of a user's
> guide that a programmer wrote, and he had a section involving software
> fixes. Right now, he has them listed as:
>
> 1.
> 2.
> 3.
>
> etc. I asked him why, that numbers are generally used to denote steps
> in procedures and the like. He responded by he likes numbers because
> someone else can refer to the document and say "Let't take a look at
> fix #3."
>
> What do you all think? Is using numbers or bullets in this situation
> the best. I think this might be a decent topic for discussion, what
> say you?
>
> Humblest,
>
> Kevin Feeman
> Technical Communicator and Web Site Designer
>
--
"You don't look American"
"Everyone looks American, because Americans are from everywhere"
- Doonesbury
Chuck Martin
Technical Writer, Seeker Software, Inc | Personal
cmartin -at- seekersoft -dot- com | writer -at- grin -dot- net
www.seekersoft.com | www.grin.net/~writer
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
