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: query re help From:David Neeley <dbneeley -at- gmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 27 Nov 2004 15:02:08 -0600
In my experience, the most significant failure of documentation
(online and printed) is the frequent omission of a really good index.
Too often, you must know the application's use of specialized
vocabulary, with no indexed synonyms--especially the most commonly
found ones--to lead you to the answers you seek.
It is definitely not for nothing that indexing is a bit of an art unto
itself, and that good nonfiction books outside of the computer field
often employ professional indexers. Occasionally, the best computer
books do too--but I personally cannot recall any documentation that
has used such an indexer.
Another method I rarely observe is to have a thorough collection of
tech support questions, paying particular attention to the users and
the questions they ask. That way, a fairly good topic list can be
developed for use in the index.
ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!
RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.