RE: Numbered Headings

Subject: RE: Numbered Headings
From: Shea Michael EXT <Michael -dot- Shea -dot- extern -at- icn -dot- siemens -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 6 Nov 2002 09:36:12 +0100


Numbered headings are very useful for showing where you are in the overall structure of the document. If I am reading section 5.2.3, I can expect 5.1 is somewhere in front of it and possibly 6.0 is somewhere after it. An argument for using it would be that the user is within a very complicated process and needs to know at what point he or she is, for example before shutting off the reactor coolant and after inserting the control rods.

I might argue for a typical software product, this level of detail is unecessary. If I want to know how to insert an anchored frame in FrameMaker, I might look up achored frame, inserting in the index and jump to that page to do the procedure. For this kind of reference I don't really care what comes before it or after it, because it isn't really relevant. The numbers then provide unnecessary information.

Michael Shea
XpressLink Documentation
c/o ICN AS BA ST2
+49 89 722-52589

--------------------------------------------------------------------
Michael Shea
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany

Phone: +49 8179 9307-19, Fax: +49 8179 9307-12
E-Mail: shea -at- r-l -dot- de, Web: www.r-l.de
--------------------------------------------------------------------



-----Original Message-----
From: Krishna Malik
Subject: Numbered Headings

<snip>

...But the boss has asked us to
avoid using numbered headings... Can any one of you throw
light in this regard?


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

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


Previous by Author: RE: STC Letter to the Editor
Next by Author: RE: What do you say....
Previous by Thread: Numbered Headings
Next by Thread: Re: Numbered Headings


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


Sponsored Ads