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: Are chapter numbes a thing of the past? From:Char James-Tanny <charjtf -at- gmail -dot- com> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 23 Apr 2009 11:21:00 -0400
> I'd hope that content is grouped logically by chapter. The reason for
> finding a chapter is that it has the content-type most appropriate for
> your question. The number is a way of labeling the chapter in a way
> easy to follow the sequence.
LOL Yes, it was organized by chapter. (It wasn't my organizational
structure and I discovered years ago that "logically" is subjective,
not objective.)
And I do understand why chapter numbers are used. I just don't like
them in footers with page numbers.
> You aren't going to chapter 5 because you want a 5. You are going to
> the chapter because it contains the configuration information for the
> XYZ-3 Conflagurator. The 5 just makes it easier to refer someone else
> to the chapter.
You are absolutely correct.
> It would have been worse if they also had to look in chapter 1-10
And they did. They had to look in a variety of chapters, depending on
the information they wanted.
Here's my issue. There's a book with 600 pages on my desk. Someone
says to me, the information you want is on page 6-103. OK then. Let's
see...maybe halfway through? Nope, that's page 4-23. Hmmm...ok, maybe
if I divide the remaining book in half and look there?
I could spend (or waste) several minutes just trying to find the dratted page.
Now picture that same book, only someone says to me, the information
you want is on page 275. Ah, just a bit before middle. If I open the
book there, I should be within 25 pages either way of the page I want.
No stumbling around the book trying to find the right chapter...just
go right to the area where the page is.
(And this process works when the book is printed to PDF, too.)
I understand the reasons why people use chapter references with page
numbers. I produce docs that way for clients that request it. I just
find it very unusable, which to me is unacceptable given that most
users aren't picking up this book because they need something good to
read...they're picking it up because they need answers. Preferably
sooner than later.
Char James-Tanny ~ JTF Associates, Inc. ~ http://www.helpstuff.com
----------------------------------------------------------
Please send follow-up questions to the list. (Inquiries sent off-list
may not be seen.)
Contact me directly (CharJT at helpstuff dot com) with business inquiries.
----------------------------------------------------------
Microsoft Help MVP since 2002
Find a Help Authoring Tool at HAT-Matrix.com ~ http://hat-matrix.com
Co-author of "Managing Virtual Teams" ~ http://www.wordware.com/wiki
AuthorIT Certified Consultant, Development, and Training
STC Secretary, 2006-2010
Web site Hosting and Design ~ http://www.jtfhosting.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-