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.
On Thu, Feb 21, 2008 at 7:48 PM, Kelly Keck <kkeck -at- imagine-one -dot- com> wrote:
> 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 raj -dot- machhan -at- gmail -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/raj.machhan%40gmail.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.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-