TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> And it is cluttered.
>
> Structure to a document can be shown using numbering, it can also be
> shown visually with layout.
Yes. True. However in most manuals the various heading
levels look rather similar in their layout. If I don´t
have a heading1 to compare to on the same page I don´t
know whether the heading that I see on a certain page
is level 2, 3 or 4. 2 point difference (as suggested)
is a noticable difference from 8 to 10. But not from
16 to 18. It´s often - even with a good layout -
ambiguous for a user who doesn´t know our layout well.
But the user doesn´t want to interpret our layout
to know where he is. He wants to solve his problem.
> Referring to a heading is complicated because if it is a physical
> (printed) document, you need the page number more that the heading
> numbering. Once on the page the text description (heading text) is
> more recognizable that numbers.
No-one would remove page numbers. However when I see
a cross-reference that says 3 "User settings" or
3.1.1 "User settings" that makes a big difference and
in one case I might check the target of the cross-
reference and in the other case I won´t.
> Numbering headings down past two level is often counter-productive,
> as is numbering when the numbers reach obtuse lengths such as having
> more than two digits throughout the number (2.13.2.23). Then you have
> users encountering problems when they mis-read and instead go to
> 2.13.23.3.
I agree. There shouldn´t be more than 4 heading levels and
only the first 3 should be numbered. In my opinion that´s
a good compromise.
Probably everyone will do what he/she prefers themselves.
I use numbered headings to orientate in documentation
and apply it myself. Others seem to ignore it and won´t
have any in their documentation.
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
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.