RE: Paragraph numbering - industry standard?

["Claire Conant" <Claire -dot- Conant -at- Digeo -dot- com>]

>>Sarah states: 

>>I've been documenting software for years now, and am writing my first
SDK. >>I hate, hate, HATE paragraph numbers; I think they're a holdover
from when >>most tech writers worked for the military and had to conform
to mil specs. >>

Sarah, I'm on your side. I don't see the point in them - AT ALL. 

The argument presented to me in favor of numbered paragraphs was that
the engineers were "used to them" and they liked to reference sections
using them. For example, they could tell a customer, "See 4.3.1.2.2 for
your answer." (And sometimes, they really did indent five levels deep.)
Granted, it is shorter, but try saying that out loud.

My argument against them is that I believe an effectively written
cross-reference and competent page numbering works just as well. I think
the paragraph numbering just clutters up the content and makes it
visually harder to read. 

Again, I don't see the point. But I'm open to being convinced as to why
they are necessary, and in what situations.

Claire Conant
Technical Editor
Digeo, Inc.
www.digeo.com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l


---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.