Re: Writing good help files

["Dana Worley" <dana -at- campbellsci -dot- com>]

HTHOn Thursday, September 04, 2008, Rob Hudson wrote: 

> 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? 

Hi Rob,

Years ago I purchased the book, "Standards for Online Communication" by JoAnn Hackos & 
Dawn Stevens. It is copyrighted 1997 -- I have no idea if it has been updated. However, it 
provides the information you are requesting. I haven't read it in many years, but I recall it was 
helpful to me at the time. JoAnn may having something new & improved by now. :)

The "Windows Interface Guidelines for Software Design" also has a section on user 
assistance. The copy I have was published in 1995 ("Covers Windows 95 & Windows NT!" 
woot!). It has good info as well. 

You may also want to look at the Vista User Experience Guidelines regarding help: 

http://msdn.microsoft.com/en-us/library/aa511449.aspx


Sorry if any of this is redundant to other posts -- I receive the digest, which contained no 
responses to your query  :)

HTH,

Dana W.



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

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.
http://www.componentone.com/DocToHelp/

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.