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: To Index of not to Index From:Susan W. Gallagher <sgallagher5 -at- cox -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 4 May 2004 14:21:45 -0400
Dan,
If it's a short book - 10 to 15 pages, maybe as many as 20
pages - then it probably doesn't need to be indexed. If it's
a narrative that is meant to be read from start to finish,
like a novel or a whitepaper, then it doesn't need to be
indexed.
What that leaves is about 90% of what we write - and that
definitely needs to be indexed. And while Dick is right, to
a certain extent, that indexing is an art and not as easy
as it looks, I disagree that you should outsource the job.
IMO, every technical writer needs to be at least competent,
if not great, at indexing and the sooner you start, the
better off you'll be and the sooner you'll get good at it.
;-)
Good Luck!
-Sue Gallagher
>
> From: dan -dot- gallagher -at- pulsartech -dot- com
> I maintain all the technical manuals here and none have an index. So I was
> wondering if an index would help customers or not.
>
> Pulsar makes fiber-optic and Power-Line carrier communications equipment,
> for utilities, with a plethora of options. There's a multitude of
> abbreviations used throughout the books, PLC, V4T, SRD and numerous
> industry abbreviations, processes and protocols. I would imagine an index
> in these books would be quite an undertaking. (job security?) hmmm.
>
> I have no idea where to start, or even if I should even think about
> including an index. Your thoughts would be appreciated.
>
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
