Writing good help files

Subject: Writing good help files
From: Rob Hudson <caveatrob -at- gmail -dot- com>
To: 'techwr-l List' <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 04 Sep 2008 13:12:42 -0400

Hi all,

I had to dive in and edit a help file recently and found myself
struggling to determine the "best practices" for task-based,
reference-based, and path-based help. Is there a good book out there
that has samples and best practices for designing help systems? I'm good
with the technical stuff but don't always know what to put at the top of
the pages, how (or when) to specify related topics, and how to apply
cross-references effectively.

ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

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.


Previous by Author: Re: Low cost online meeting space
Next by Author: Best help file examples
Previous by Thread: RE: Close to End of Story: Single-source with Word - Help solutionsquestion
Next by Thread: RE: Writing good help files

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

Sponsored Ads