Online Help

[Joe Malin <jmalin -at- jmalin -dot- com>]

Hi!

I've worked on two online help projects, including one that I designed
and built myself. I think that the tools and technology are a minor
issue, compared to the logistics of organizing and writing topics. I do
suggest that you look at the books that others have recommended, but I
have some additional comments:

    * Effective online help is more than splitting a manual into
      separate chapters. You may find that you need to do further
      "chunking" and even some rewriting.
    * Organize the information by type. Ensure that you separate
      conceptual, procedural, and reference information. The table of
      contents for your online help should reflect this, but you should
      also ensure that each topic you produce is focused on a single
      information type.
    * For online help, the basic unit is not the chapter but the topic.
      Each topic should be small, relatively self-contained, and
      independent.
    * Ask around for some examples of good online help. I don't know of
      any network management examples, offhand. Really good examples are
      rare.

Joe
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help 
format plus PDF, HTML and more. Flexible, precise, and efficient content 
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.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/techwhirl/ for more resources and info.