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:Robert Lauriston <robert -at- lauriston -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 3 Dec 2009 10:42:53 -0800
Sure, but even then, once you've identified the correct version, you
can just tell them the page number.
Chapter numbers are arbitrary and meaningless. If they change as the
document evolves, they're a potential source of confusion. If they
don't change, the document typically ends up disorganized, with new
stuff going at the back rather than in the most logical place.
Also, even hardware documentation is increasingly distributed only as PDF.
On Thu, Dec 3, 2009 at 10:35 AM, Fred Ridder <docudoc -at- hotmail -dot- com> wrote:
> But not everybody documents software or software-based products that come
> with on-line help. Both situations where I had to provide tech support (by
> fax, e-mail, and phone) were hardware manufacturers who still delivered
> printed documentation with the product. When communicating with a customer,
> the first order of business was establishing what version of the product and
> of the printed manual they had in their hands because both of them evolved
> over the product's life cycle.
>
> Fred Ridder
>
>
>> Subject: RE: Chapter-page numbering, reasons for
>> Date: Thu, 3 Dec 2009 09:57:03 -0800
>> From: Leonard -dot- Porrello -at- SoleraTec -dot- com
>> To: robert -at- lauriston -dot- com; techwr-l -at- lists -dot- techwr-l -dot- com
>>
>> Exactly! With on-line help, there is usually no need to reference even
>> chapter name. It's far more simple to have the user search using a
>> sufficiently unique search term. Once in the needed topic, they can
>> reference the TOC, in which the topic will be highlighted, to see how
>> the topic fits into the big picture.
>>
>> Leonard
>>
>> -----Original Message-----
>> From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
>> [mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
>> om] On Behalf Of Robert Lauriston
>> Sent: Thursday, December 03, 2009 9:51 AM
>> To: techwr-l -at- lists -dot- techwr-l -dot- com
>> Subject: Re: Chapter-page numbering, reasons for
>>
>> Chapter and section numbers change as new chapters and sections are
>> added, so there's potential confusion there.
>>
>> 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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
