Re: Value of Indexes in Short User Guides

[Eddie Hollon <eddiehollon -at- yahoo -dot- com>]

>Jennifer O'Neill wrote:

>We provide a TOC (2 heading levels) only. Such docs also
have the smaller page size, A5, and are for our cheaper products.
>Consequently we must ship all language versions in the same box
(manuals for such products are printed. Can't use a CD). 

>As a
result page count matters A LOT as we've to fit around 10 language
versions in the same box. So we get a bit paranoid on >page count. You
don't say if you localise your user guides and how you ship them. 

We
do localize our content and, although cost of printing and shipping
manuals with the product is an issue, it's one the manufacturer must
deal with - we simply produce the documentation and return it to the
manufacturer for printing, packaging, and shipping.


>David Chinell wrote:
>My favorite view of a tech writer is that he can do
everything required to create a finished product. This includes the
creation of text, >images, and random access tools, like the index.
However, the creation of a useful index is much more complicated and
difficult than >one might guess. It should always be more than an
alphabetized list of headings.

We share a similar view of tech writers and indexes in general. Thanks for the info--the guidelines are quite a help.

Most of the problem I'm having is trying to set a style for selecting
topics. I think for these relatively short user guides, the guideline
for limiting entries to two levels each is a good one, but I'm having a
little harder time creating a guideline that describes how to select
topics. I've consulted guidelines from the American Society of
Indexers, The Chicago Manual of Style, and other "expert" references,
but too little of this guidance applies to consumer
electronics or, I think, fits the needs of the audience I'm addressing.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.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/techwhirl/ for more resources and info.