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 for web application From:John Garison <jgarison -at- ide -dot- com> To:"'Kaya Balke'" <kaya -at- hungryminds-inc -dot- com>, TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 13 Jan 2000 14:27:04 -0500
I have done the "roll your own" approach using an HTML editor and I have
used HATs to produce HTML-based (NOT Html Help) online doc for web
applications.
I go with the tool approach now, and I use ForeFront's InterHelp format to
do it. My writers can use the familiar HAT interface, as well as create
popups and secondary windows. And it automatically creates the
expand/collapse tree view TOC, a full-text searchable index, and all the
other modern conveniences without any extra effort. I also find this to be
more easily maintained than hand-made help.
I find its output works well in both IE and Netscape (as long as you don't
use ANY file names with spaces in them!).
Just my 2¢ worth,
John Garison
Documentation Manager
Integrated Development Enterprise, Inc.
150 Baker Avenue Extension
Concord MA 01742-2174
978.402.2907 Voice
978.318.9376 Fax
-----Original Message-----
From: Kaya Balke [mailto:kaya -at- hungryminds-inc -dot- com]
Sent: Wednesday, January 12, 2000 12:23 PM
To: TECHWR-L
Subject: online documentation for web application
Hi all,
I need to create online documentation for a web application, and I'm trying
to determine both the best tool to do the job and the best format for the
documentation.
I'm wondering if I can write documentation directly in an HTML text editor,
such as HomeSite, or should I use MS Word (FrameMaker is not in the budget)
and then convert it to HTML? Any problems with using HomeSite to create user
docs that I should be aware of? Also, I'd like to take a look at existing
online documentation to get ideas but haven't been able to find any. Any
suggestions on which sites have online documentation?