Re: How Would You

Subject: Re: How Would You
From: Robert Plamondon <robert -at- PLAMONDON -dot- COM>
Date: Fri, 29 Aug 1997 08:11:16 -0700

Rita Nesslroth wrote:

>Better yet is a company-wide tracking system that numbers all bugs:
>each bug is identified as #666 or whatever, so everyone knows which
>bug is being discussed, and you get out of having to number paragraphs
>that don't want to be numbered.

This is appropriate if the number of bugs is large, though my
experience has been that software groups throw away and reimplement
their bug databases at such a high rate that the existence of
a meaningful numbering scheme can't be relied upon. However, I think
that the concept (mentioned by others) that "numbered paragraphs are
only for numbered procedural steps" is silly. Numbered lists are for
anything that a reader would find convenient to think about or refer
to as part of an enumeration, or which the writer finds convenient
to present as one. They may well have no verb at all, making
them completely non-procedural -- enumerations of major subassemblies,
parts lists, and such.

-- Robert

--
Robert Plamondon, High-Tech Technical Writing, Inc.
36475 Norton Creek Road * Blodgett * Oregon * 97326
robert -at- plamondon -dot- com * (541) 453-5841 * Fax: (541) 453-4139
http://www.pioneer.net/~robertp

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


Previous by Author: Re: TECHWR-L Digest - 26 Aug 1997 to 27 Aug 1997
Next by Author: Re: Introduction and Tech Writing Horror Story [Long]
Previous by Thread: Re: How Would You
Next by Thread: My wife the job hunting instructional designer


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads