Re: Numbered list vs bulleted list

["Tahmaseb, Charity (C) (STP)" <charity -dot- tahmaseb -at- GUIDANT -dot- COM>]

Hi Don,

I took this directly from "The Elements of Technical Writing" by Gary
Blake and Robert W. Bly:

"Present instructions as a series of numbered steps.  If an operation is
clearly a step-by-step procedure, you can make life easier for the
reader by writing the instruction manual as a series of numbered steps."

At this point the book gives us an example of a numbered-step procedure
and continues with:

"With numbered steps, if the operator needs to discuss the procedure
with your support staff, he or she can ask a question by referring to
"step 3" instead of "the fifth line down in the second paragraph on the
fourth page, where it says to release the whatchamacallit switch."

Now you have two sources that recommend numbered lists for procedures.
:-)

Charity

Charity Tahmaseb
Technical Writer
Guidant Corporation / CPI
E-202, 4100 Hamline Ave. N., St. Paul, MN 55112-5796
mailto:charity -dot- tahmaseb -at- guidant -dot- com


> -----Original Message-----
> From: Don Timmerman [SMTP:timmerma -at- IPDLINK -dot- IPD -dot- ANL -dot- GOV]
> Sent: Wednesday, November 19, 1997 8:34 AM
> To:   TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject:      Numbered list vs bulleted list
>
> Hi all,
>
> I've just returned from the archive with very little success.  Here's
> the scenario.
>
> The author (programmer) wrote a software installation and user guide
> for a DOS program (not a commercial software).  Action steps are in
> bullet lists; each bullet has been replaced with a graphic pointing
> hand (side view).
>
> The editor had to leave the project for several days (business trip)
> and I am filling in because of the project deadline.  I contend that
> any list of action steps be numbered if those steps must be performed
> sequentially.  The DOE Standard Writer's Guide for Technical
> Procedures states the following, "Action step numbering identifies
> individual action steps and their sequence."
>
> The editor contends that this item is not an issue.  The bullet list
> is fine because that method is used in many software docs.  What say
> you?  Also, have I answered my own question?
>
> Don Timmerman, dtimmerman -at- anl -dot- gov
> Sr. Technical Writer
> Argonne National Laboratory
> Argonne, IL
>
> PS Argonne Nat'l Lab is a contractor to the Department of Energy.
>


Posts: mailto:techwr-l -at- listserv -dot- okstate -dot- edu
Commands: mailto:listserv -at- listserv -dot- okstate -dot- edu (e.g. SIGNOFF TECHWR-L)
Archives: http://listserv.okstate.edu/archives/techwr-l.html,
	http://www.documentation.com/, or http://www.dejanews.com/
Subjects: JOB:, QUESTION:, SUMMARY:, ANNOUNCE:, or none of these.