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.
Subject:Re: Online Documentation vs. Help From:Damien Braniff <Damien_Braniff -at- PAC -dot- CO -dot- UK> Date:Thu, 11 Dec 1997 08:54:49 +0000
To me the main difference is in the use (and I agree with Ron's comments
that both need careful thought when designing).
Online help is designed to provide SPECIFIC help be it on a field,
function, screen or whatever. You should be able to access it directly
from the relevant screen etc or else search for (via contents, index,
whatever) the help file to find out what you want. In many ways I see it
as analagous to a hard copy User manual with the majority of the
information being of the form "how to" with additional background
information as required.
Online docs I see (roughly!) as Reference Manuals. They probably contain
the relevant user info but provide a much more "rounded" picture of the
application etc. General overview, ideas behind it etc. All this would be
"layered" to allow the user to get the depth of information required. A
novice could (or should be able to) use the online docs to get a feel for
the product, what it does and how to use it.