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.
You've taken me out of context. I am talking about documentation
strategy for a product or company, not piecemeal changes within a single
document. Otherwise, I totally agree with you.
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 11:04 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Chapter-page numbering, reasons for
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.
Regulation numbers are a headache to maintain, too, but that's
unavoidable.
On Thu, Dec 3, 2009 at 10:56 AM, Leonard C. Porrello
<Leonard -dot- Porrello -at- soleratec -dot- com> wrote:
> Which is why I said I don't think this is an either/or situation. As
> several others have pointed out, its all about (customer requirements
> and) how the documentation is being used.
>
> Leonard
>
> -----Original Message-----
> From: neilson -at- windstream -dot- net [mailto:neilson -at- windstream -dot- net]
> Sent: Thursday, December 03, 2009 10:51 AM
> To: Robert Lauriston; Leonard C. Porrello; techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Chapter-page numbering, reasons for
>
> On the other hand, when you're charged with violating some silly
> regulation it's mandatory to know the section and paragraph number, so
> that you can determine that indeed they are trying to regulate your
> back-yard garden as if it's an industrial waste site.
>
> ---- "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> wrote:
>> 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.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Leonard -dot- Porrello -at- soleratec -dot- com -dot-
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-
