Beginning Titles with "How To"

Subject: Beginning Titles with "How To"
From: "Kelly Keck" <kkeck -at- imagine-one -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Feb 2008 09:18:14 -0500

Deborah Slutzky wrote:

>Hello All,
>I need some opinions. Just wondering how folks feel about beginning
>topic titles with "How to..." I'm used to beginning them with a gerund,
>but the shop that I am now working for has an assorted bag of formats
>and I run into this once in a while. Personally, I don't care for it
>because I think the entire Help is a How to.....but I'd like some
>thoughts from others.

I dislike it for a couple reasons:

-It gets repetitive, especially if the "How To" headings are included in
your TOC, one right after the other.

-It buries the real topic behind filler words, making it tougher for someone
skimming through headings or a TOC or glancing at a title to find what
they're looking for.

-As you said, the whole thing is a "How To," so it should go without saying.

Since you refer to Help rather than to a manual, I assume this on-line help?
If so, the "How To" might be less jarring, since the user is looking at each
piece separately rather than all together. Still, I'd prefer gerunds if you
have the leeway to change them--especially if the mixed bag of formats your
refer to is occurring in a single Help system. If that's the case,
rewording for consistency would be a good thing.

Kelly Keck



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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.


Follow-Ups:

Previous by Author: Re: Seminar ideas for advanced practitioners
Next by Author: Re: Michael Bremer's "Untechnical Writing" Book
Previous by Thread: new job no
Next by Thread: Re: Beginning Titles with "How To"


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


Sponsored Ads