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.
Robert Lauriston wrote about Chapter-page numbering:
"I think it is either-or. Either number everything down to the
paragraph level (as in regulations), or nothing. Anything in between
is a lot of effort for negligible payoff. It's a holdover from the
print era."
Hi Robert,
I'd like to add to what Leonard and others have said, which is essentially
"you do what the customer wants." There is no need to number things down to
the paragraph level. Printed books are read linearly and should have a TOC.
Chapter number-Page Numbers assist the user in locating the subject matter
they discovered in the TOC. Adding paragraph level number may be required in
legal (as in law) documents, but not in tech manuals (unless the customer
wants it). Software Help does not work well with my customers because of the
nature of the product, and I believe there are other similar situations
encountered by other writers. Each situation is unique and it requires an
open mind to produce the documentation necessary to support those
situations. The print era may be over for some people, but I'm making a
rather decent living developing print documents for one customer and
context-sensitive help for another. The latter, even if they desire a
printout of the "manual" does not use chapter or paragraph numbers. They
wouldn't make any sense in a Help where navigation is anything but linear.
Regards,
Al Geist
Technical Communicator, Help, Web Design, Video, Photography
Office/Msg: 802-872-9190
Cell: 802-578-3964
E-mail: al -dot- geist -at- geistassociates -dot- com
Website: www.geistassociates.com
See Also:
Fine Art Photography
Website: www.geistarts.com
"...I walked to work, quit my job, and kept walking. Better to be a pilgrim
without a destination, I figured, than to cross the wrong threshold each
day." (Sy Safransky)
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-