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.
Joe Malin wondered: <<I have written procedures for creating various
entities in the architecture I'm documenting. In these procedures, I
usually refer to the entity in singular form. For example, the lead-in
to creating a topic is
*Creating a Topic* (title)
To create a topic: (introduction to procedure)
In the index, though, I refer to the entities in the plural:
topics
creating
deleting
Does this make sense?>>
Whether or not this is orthodox indexing, I prefer it because it
eliminates the need to say "creating a" in the index
subentries.Similarly, the index subentry under "Creating" should be
"Topics", not "A topic".
If you want to be a little more consistent, change the heading to
"Creating topics" to match the index. That's a very common style, and
eliminates the mismatch between the singular and plural. The mismatch
with the "to create..." isn't important in this case because the index
entry refers to the larger entity (the whole section whose title is
"Creating...", not to that individual sentence.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList