Best Practices in Context-Sensitive Online Help

Subject: Best Practices in Context-Sensitive Online Help
From: Sue McKinney <smckinn2001 -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 6 Jul 2009 10:19:51 -0700 (PDT)

I've been asked to present information on the best way to redesign our online help, currently NOT context-sensitive, to be context sensitive. In the past I've written help topics describing each dialog and linking to the associated tasks that can be performed. That way the procedures aren't cluttered with all the field explanations, and the procedural topics also link back to the associated dialog topics. Make sense?
Or is there another way? The reason I might not just link to a procedure from each dialog is that a) there may be more than one task that can be performed from a certain dialog or b) an individual dialog may be only 1 step in a larger procedure.
Thanks, and please respond to me directly as well as to techwr-l as I'm on digest.
Sue McKinney


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.

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!

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

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 for more resources and info.

Please move off-topic discussions to the Chat list, at:


Previous by Author: Job hunt wierdness
Next by Author: Calling All RoboHelp Experts!
Previous by Thread: Anyone want to help with a Cloze Procedure?
Next by Thread: Re: Best Practices in Context-Sensitive Online Help

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

Sponsored Ads