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.
I'm done to the editing part of my book, and it's time to make tough
style decisions.
This, of course, exposes my lack of experience!
Here's my current conundrum:
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? Using the plural in the procedure title seems to
make sense, but then using it in the procedure introduction doesn't. On
the other hand, using the singular in the index doesn't feel right to
me.
Joe
TuVox, Inc.
19050 Pruneridge Avenue Suite 150, Cupertino, CA 95014-0715
Joe Malin
Technical Writer
(408)625.1623
jmalin -at- tuvox -dot- com
www.tuvox.com <http://www.tuvox.com/>
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
