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: Short Indexing Sample? From:dmbrown -at- brown-inc -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 17 Jun 2002 16:15:44 -0700
In answer to a question about whether to include the indexed text when asked to provide a "short indexing sample" Goober wrote:
>
> ...I'd guess the latter, as the former only illustrates your layout
> capabilities and that you know what an index should look like.
>
> On the flip side, if they only want to look at the index entries,
> it's obvious they don't know what goes into a good index or really
> know what they are looking for...
I'd say take the entire index, but not necessarily the text pages.
Anyone who knows and cares about indexing will be able to get a lot from it--consistency of entries, effectiveness of double-posts, integrity of cross-references, and much more--even without seeing the source material.
The best solution would be to provide a complete index that happens to be short--say 4 or 5 pages.
Of course, if the text pages are available, you could offer them, too.
HTML Indexer 4 is still the easiest way to create and maintain indexes
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.
Now with fully integrated cross-references, target frames and windows,
multiple-file output, "one-step accept" of default entries, and more!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.
