Re: Help file TOC Sentence VS Question

Subject: Re: Help file TOC Sentence VS Question
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L -at- lists -dot- techwr-l -dot- com
Date: Wed, 28 Oct 2009 13:00:21 -0700

Good rule. I never thought of it consciously, but I generally follow it.

One occasional exception I make is for "X, see Y"-style entries when a
user might be looking for a verb that's not used in the text.

On Wed, Oct 28, 2009 at 12:35 PM, Julie Stickler <jstickler -at- gmail -dot- com> wrote:
> On Tue, Oct 27, 2009 at 4:41 PM, Robert Lauriston <robert -at- lauriston -dot- com> wrote:
>> I don't see any problem with an index section such as:
>>
> I was taught that the first level entry in an index should always be a
> noun, not a verb.
>
> Groups
>   creating
>   deleting
>   managing
>
> Because while you say "create" I may be thinking "add" or "insert" or
> "generate."    Your convention is "delete" by my brain is looking for
> the index entry for "remove." etc.  Plus, I find that it's generally
> easier to come up with the "See also" pointers for nouns than for
> verbs.
>
> Julie Stickler
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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/archive%40web.techwr-l.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


References:
RE: Help file TOC Sentence VS Question: From: kathleen
Re: Help file TOC Sentence VS Question: From: Robert Lauriston
Re: Help file TOC Sentence VS Question: From: Julie Stickler

Previous by Author: Re: Help file TOC Sentence VS Question
Next by Author: Re: Recommended web site programs
Previous by Thread: Re: Help file TOC Sentence VS Question
Next by Thread: Re: Help file TOC Sentence VS Question


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads