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:"Cramer, Kim" <kcramer -at- NCSLINK -dot- COM> Date:Wed, 27 Aug 1997 15:05:00 -0700
My questions are: Why are software fixes listed in a User's Guide? If
they are fixes that are complete, they should be documented like any
other program function. If they are yet-to-be-completed fixes, why are
they included in documentation of the current product?
We are providing a list of "known problems" with the latest version of
our product. The list will be on our client-access-only web site. Each
problem is identified by our internal problem number (four or more
digits). Because it's in a separate, clearly titled document, there
won't be any confusion on whether they are steps.
Perhaps you could move your fixes list into a separate document and make
everybody happy.
*************
Kim Cramer mailto:kcramer -at- ncslink -dot- com
Sr. Information Developer
NCS Education, Mesa AZ
*************
----------
From: Feeman Kevin SC2275
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: How would you
Date: Wednesday, August 27, 1997 2:04PM
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
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
