Re: Help file TOC Sentence VS Question

Subject: Re: Help file TOC Sentence VS Question
From: Keith Hood <klhra -at- yahoo -dot- com>
To: TECHWR-L -at- lists -dot- techwr-l -dot- com, Robert Lauriston <robert -at- lauriston -dot- com>
Date: Tue, 27 Oct 2009 12:36:44 -0700 (PDT)

I agree with Robert's method. Also, (non-scientific part here) I don't like using questions in headings or TOC entries because a technical document is supposed to be where the user comes for answers to questions. It's supposed to be authoritative, to reassure him that he's found where his questions will be answered. I think it's good for the reader's peace of mind to use a structure that does not raise questions.

--- On Tue, 10/27/09, Robert Lauriston <robert -at- lauriston -dot- com> wrote:

> From: Robert Lauriston <robert -at- lauriston -dot- com>
> Subject: Re: Help file TOC Sentence VS Question
> To: TECHWR-L -at- lists -dot- techwr-l -dot- com
> Date: Tuesday, October 27, 2009, 3:11 PM
> I prefer to put the relevant verb
> first:
>
> Time Cards
>   Understanding Time Cards
>   Create a Time Card
>   View a Time Card
>   Find a Time Card
>
> On Tue, Oct 27, 2009 at 12:02 PM, Robert Courtney <bobsc1 -at- earthlink -dot- net>
> wrote:
> > I have usually used questions in my help files on how
> to do things. I
> > use sentence headings for some things such as objects
> that I need to
> > discuss. Such as:
> >
> > Time Cards
> >    What is a Time Card?
> >    How do I Create Time Card?
> >    How do I View A Time Card?
> >    How do I Search a Time Card?
> >
> > VS
> >
> > Time Cards
> >    What is a Time Card?
> >    Creating a Time Card
> >    Viewing a Time Card
> >    Searching a Time Card
> >
> > Is there really a preference to using a sentence TOC
> and headings vs
> > questions to accomplish tasks?
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 klhra -at- yahoo -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/klhra%40yahoo.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
>
>

__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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: Robert Lauriston

Previous by Author: RE: Click X, or click the X button?
Next by Author: Re: Interesting Article on Windows 7
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