Re: Chapter-page numbering, reasons for

Subject: Re: Chapter-page numbering, reasons for
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 3 Dec 2009 09:50:38 -0800

Chapter and section numbers change as new chapters and sections are
added, so there's potential confusion there.

When I need to cite a particular topic in a context where there are no
hyperlinks (e.g. a reference in readme.txt to a topic that discusses a
new feature), I use breadcrumbs, e.g. "For more information, see Using
Widgetworks > Creating a New Widgetworks Fubar > Creating a Fubar from
a Template in the User Guide or online help."

If I'm talking to someone on the phone, I find out whether they're
looking at the PDF or the online help, and then tell them the fastest
way to find the topic.

On Thu, Dec 3, 2009 at 9:18 AM, Fred Ridder <docudoc -at- hotmail -dot- com> wrote:
> As someone who has worked in positions where I had to provide tech support
> to customers (sometimes resellers, sometimes end users), I have to disagree
> with Robert and Leonard. It is pointless to refer someone to the
> documentation (i.e. tell them to RTFM) without being able to point them to a
> specific topic that addresses their issue. And unless you have some process
> in place to ensure that *every* topic has a unique title, the chapter and
> section numbers that you say have no purpose are in fact extremely
> useful. You really handicap your support people (assuming that anybody still
> has people who provide tech support...) if you don't provide some unique way
> of identifying every topic in the documentation.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Chapter-page numbering, reasons for: From: Nancy Allison
RE: Chapter-page numbering, reasons for: From: Dan Goldstein
Re: Chapter-page numbering, reasons for: From: Robert Lauriston
RE: Chapter-page numbering, reasons for: From: Leonard C. Porrello
RE: Chapter-page numbering, reasons for: From: Fred Ridder

Previous by Author: Re: Chapter-page numbering, reasons for
Next by Author: Re: Chapter-page numbering, reasons for
Previous by Thread: RE: Chapter-page numbering, reasons for
Next by Thread: RE: Chapter-page numbering, reasons for


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

Sponsored Ads


Sponsored Ads