Re: Are chapter numbes a thing of the past?

Subject: Re: Are chapter numbes a thing of the past?
From: Jonathan West <jwest -at- mvps -dot- org>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 23 Apr 2009 13:39:34 +0100

> Do the chapters/appendices in User Guides, etc. have to have numbers and letters? I was taught that they do, but understand that there a trend to move away from them. Is this true?
>

It depends. There's no inherent reason why they have to, so you can
make a decision as to whether they are useful in your particular case.

The main reason numbers are put in is for ease and clarity of
reference. It is much easer to tell someone "Take a look at section
5.3 of the XYZ Guide" than to say "look at the section titled
'left-handed widgets' halfway down page 27 of the XYZ Guide".

If you need to reference specific bits of documentation in this way,
either because one document makes a reference to another, or because
your support people need to point users to specific paragraphs in a
document in order to quickly & efficiently answer user queries, then
numbered chapters and paragraphs are a good idea.

Where documents have legal and/or contractual purposes, and make cross
references within and/or between documents, then numbered clauses are
pretty much essential in order to ensure that these references are
unambiguous.

Regards
Jonathan West
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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:
Are chapter numbes a thing of the past?: From: Saunders, Ian

Previous by Author: Re: telecommuting - advice needed
Next by Author: Re: Are chapter numbes a thing of the past?
Previous by Thread: Re: Are chapter numbes a thing of the past?
Next by Thread: Re: Are chapter numbes a thing of the past?


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

Sponsored Ads


Sponsored Ads