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: When should I add index terms? From:Kevin McGowan <thatguy_80 -at- hotmail -dot- com> To:<litlfrog -at- gmail -dot- com>, TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 12 Apr 2010 10:26:25 -0400
Hi Joe,
IMO, the answer is "both." It's good to keep adding Index items as you go along, just make sure you're following a consistent style. It's best to do this as you go...or else when you get to the end of the project, you may run out of time, and your "index" is suddenly not as much of a priority.
Towards the end, add a "thorough index edit" to your list of pre-publication check activities to make sure things look good. You'll have time to add any forgotten entries, or to fix any oddities that may have crept up.
Best of luck!
Kevin
> Date: Mon, 12 Apr 2010 09:20:35 -0400
> Subject: When should I add index terms?
> From: litlfrog -at- gmail -dot- com
> To: techwr-l -at- lists -dot- techwr-l -dot- com
>
> Hello all,
>
> I've done documentation at jobs for years, but I've got my first big,
> official project now. I'm rewriting over some VERY outdated help files
> for software, creating many new help pages, and assembling them into a
> .chm file in Microsoft HTML Help Workshop. My question right now is
> about indexing. When should I add terms to my index? Is it easier to
> do as I go along and add new pages to the help file, or more efficient
> to wait until the project is near completion? Thanks.
>
> --
> Joe Weinmunson
>
> Have nothing in your house that you do not know to be useful, or
> believe to be beautiful.
> --William Morris
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
> produce desktop, Web, or print deliverables. Just write (or import)
> and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
>
> Explore CAREER options and paths related to Technical Writing,
> learn to create SOFTWARE REQUIREMENTS documents, and
> get tips on FUNCTIONAL SPECIFICATION best practices. Free at:
>http://www.ModernAnalyst.com
>
> ---
> You are currently subscribed to TECHWR-L as thatguy_80 -at- hotmail -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/thatguy_80%40hotmail.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/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
_________________________________________________________________
Hotmail & Messenger are available on your phone. Try now. http://go.microsoft.com/?linkid=9724461
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
