Help file TOC Sentence VS Question

Subject: Help file TOC Sentence VS Question
From: Robert Courtney <bobsc1 -at- earthlink -dot- net>
To: TECHWR-L -at- LISTS -dot- TECHWR-L -dot- COM
Date: Tue, 27 Oct 2009 12:02:08 -0700

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?

--
Robert Courtney
Technical Writer
PDSI â Principal Decision Systems International
O: (800) 850-7374 ext 1283
F: (714) 703-3000
E: robertcourtney -at- pdsi-software -dot- com
www.pdsi-software.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


Follow-Ups:

Previous by Author: Re: Recommended web site programs
Next by Author: Web publication style
Previous by Thread: RE: Subject: Recommended web site programs
Next by Thread: Re: Help file TOC Sentence VS Question


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

Sponsored Ads


Sponsored Ads