section numbering

Subject: section numbering
From: "Peter Ring, PRC" <prc -at- PIP -dot- DKNET -dot- DK>
Date: Sat, 15 Mar 1997 12:24:29 +1

On 14 March 1997 Matt Ceglia wrote:

> I've been assigned to redesign our existing documention, and our
> contract writer (who will be doing most of the rewriting) has
> strongly suggested that we use a section-numbering scheme to
> facilitate cross-referencing. The manual is a 150-page reference
> guide for a networking hardware/software product. It is targeted
> to a fairly nontechnical audience.

> Although I'm not necessarily opposed to section numbering, I don't
> see a lot of it anymore. Are there any guidelines for determining
> whether these numbers are worthwile? Does anyone have strong
> opinions for or against section numbering?

See the pros and cons on my "Tip of the month from PRC May 1996":
Numbering of chapters & sections. The URL to this specific page is
http://www.pip.dknet.dk/~pip323/ufm/tip-9605.htm

Greetings from Denmark

Peter Ring
PRC (Peter Ring Consultants)
- specialists in user friendly manuals and audits on manuals.
prc -at- pip -dot- dknet -dot- dk
http://www.pip.dknet.dk/~pip323/index.html
- the "User Friendly Manuals" website with links, bibliography, list
of prof. associations, and tips for technical writers.

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: Examples of bad manual texts
Next by Author: Reporting Structure for Writers in Large Corporations
Previous by Thread: Re: Section Numbering
Next by Thread: Re: About anal-retentive...


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

Sponsored Ads


Sponsored Ads