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: Word to on-line or Frame to on-line From:Scott Miller <smiller -at- CORP -dot- PORTAL -dot- COM> Date:Tue, 21 Oct 1997 16:27:29 -0700
>>>>>>>
>Is it best to continue managing my large docs in Word and develop online
>material from there, or to move all the docs to Frame and develop online
>material from there.
>
>Also, can someone define for me on-line help versus on-line
>documentation? Or point me to a good source so I can educate myself?
><<<<<<<
>
>With Word, you have an easy path to online help, since a lot of help
>authoring tools use Word as the text editor. It's possible to go from Frame
>to RTF to online help, but tricky.
>
>As for the difference between online help and online documentation... Online
>help is typically tied to a software application, and tells the user how to
>accomplish their goals when using that software application. It is
>context-sensitive for the task at hand, and extremely concise. The user
>should be able to:
>- Find the correct information quickly
>- Find only the information they need, when they need it
>- Find additional information, if they need it
>- Find information using their own language
>
>Online documentation is typically not tied to a single application, but is
>more wide in scope. A typical online documentation implementation is
>something like all of the technical reference, user's guide, installation
>guides, etc. for a suite of products. Online documentation typically includes
>some sort of full-text search mechanism such as the Verity search engine or
>Personal Librarian. It's more like a bunch o' books on a CD-ROM. When you
>have a ton of stuff to document, a whole shelf full of books, online
>documentation is very effective, if the search engine is good and (MOST
>IMPORTANT) if the documentation is organized in a way to make it work online,
>as opposed to printed.
>
>Choosing a search engine is a huge topic, although I've been out of the
>online documentation loop for a while, so maybe there is a clear-cut winner
>out there. Once you have chosen the search engine that is appropriate for
>your documentation, it will be easier to decide on the tool to produce it
>(Word or Frame).
>
>- Scott Miller
>Portal Information Network
>smiller -at- portal -dot- com
>