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: "using" as a verb in a task heading From:Peter Neilson <neilson -at- windstream -dot- net> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 02 Jul 2008 21:42:43 -0400
Milan Davidovic wrote:
> Stripping out the verb and leaving it as Method A/B (per Leonard) is
> looking kind of good to me. Any other ideas?
When making the index, refrain from putting in any entries under
"Using". Yes, it will group them all together, but nobody will look
there. Instead, make entries for the nouns and verbs associated with the
concept:
There is no law (at least in my jurisdiction) that says index terms need
appear in the refered location. The index is to help the readers, even
those coming from other technologies or systems. You can even use terms
for concepts that are impossible within the system. For example, suppose
your system is an archival one in which deletion of files is disallowed.
An index entry for "Files, deletion" might be appropriate; "Files,
deletion not allowed" might of course be even better.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-