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.
Subject:Re: Chapter-page numbering, reasons for From:<neilson -at- windstream -dot- net> To:Robert Lauriston <robert -at- lauriston -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 3 Dec 2009 11:20:29 -0600
During the printed-docs era we used page numbers in the form of 7-12 to enable the use of update packages. That style of numbering is now unnecessary, but page numbers (or some other kind of numbering) can still be quite worthwhile.
A larger document should be split into chapters. Whether or not the chapters need numbers, or whether the paragraphs need 7.2.3, 7.2.4, etc. numbering depends upon the purpose of the document. Some reference manuals, in which one section closely resembles another, need paragraph numbering to distinguish particular entries. Laws and military manuals come to mind. For other books the fancy numbering is superfluous or worse.
Numbering also allows rewriting to be done by people who are not in charge of the entire document. "Harry, please replace section 7.4 with Jimmy's description of the new model. Make the numbering works the same way. I think MS Word has some way to do that." "Sure, boss. I'll figure it out. (I hope.)"
On the other hand, documents that are prepared as HTML or blogs generally have no numbering at all, and sometimes (for that very reason) are hard to comprehend if there are many detailed sections some of which look like others. "Enabling the Builder Dialog" and "Enabling the Dialog Builder" might well be retitled as "Section 3 - Enabling the Builder Dialog" and "Section 4 - Enabling the Dialog Builder"
---- Robert Lauriston <robert -at- lauriston -dot- com> wrote:
> My preference is to get rid of chapter numbers entirely. I don't see
> any purpose for them.
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-