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: Indexes and PDF Files From:PRASANNA PRABHU <prasanna_prabhu01012003 -at- yahoo -dot- co -dot- in> To:Jay Maechtlen <techwriter -at- covad -dot- net>, "Klasovsky, Nick" <nklasovsky -at- nordson -dot- com> Date:Wed, 28 Feb 2007 16:59:28 +0530 (IST)
Hi Nick,
I have a strong suspicion that the sampling methodology used for your user surveys did not accomodate all kinds of users. Surveys can throw up highly skewed results depending on the sampling methodology, sample size, and questions posed in the survey questionnaire.
Also, the inclusion or exclusion of an index in the manual will depend on the content in the manual. If the various key words of the product/service appear in the topic headings, you would not need an index. Such manuals have very little text content in the pages; they have more illustrations and lists - something like an instructions manual...Your manuals may be of this type. Hence the results of your user survey show that indexes are not required.
Regards,
Prasanna M. Prabhu
Technical Lead
Citec Engineering and Information India
+919886754228
----- Original Message ----
From: Jay Maechtlen <techwriter -at- covad -dot- net>
To: "Klasovsky, Nick" <nklasovsky -at- nordson -dot- com>
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Wednesday, 28 February, 2007 1:11:04 PM
Subject: Re: Indexes and PDF Files
Klasovsky, Nick wrote:
> Nobody addressing this subject has mentioned PDF bookmarks.
>
> We do not include indexes in our equipment manuals, only tables of
> contents, because our user surveys have showed us that most of our users
> don't know what an index is much less how to use it. Most don't even use
> the table of contents, just page-flip until they find what they want.
>
> We publish our printed equipment manuals on the internet as PDF files,
> and we bookmark each and every one. We set the file to open with
> bookmarks displayed. Our users use the bookmarks to jump to the topics
> they need. The primary bookmarks are the topic headings, and by manually
> adding bookmarks as needed we can make the bookmarks serve the same
> purpose as indexes.
>
dang- someone with a clue!
very good...
Jay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 prasanna_prabhu01012003 -at- yahoo -dot- co -dot- in -dot-
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.
__________________________________________________________
Yahoo! India Answers: Share what you know. Learn something new http://in.answers.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-