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:Creating Online Help From:Jennifer Zilliac <jennifer -at- SMARTDB -dot- COM> Date:Mon, 15 Dec 1997 17:11:07 -0800
I think my last question to this group may have been too general --
I didn't get any responses. I've been gathering information and
questions, and now I can formulate more specific questions.
Here's my situation: I'm the sole technical writer for a small
software company. I've just been here for a month or so. I'm
completely reworking the documentation set for our main
product, which currently has four books. There are another fifteen
very small books that I have to do some minor work on.
Our main product has no online help and no online documentation.
I have never put together an online help system, yet I need to
start guiding the ship into that port. I need to suggest when
and how we should implement online documentation and/or help.
I'm considering suggesting the following timeline:
1. Ship online documentation with GA, end-of-January 1998.
2. Create an online help system using RoboHELP for beta shipments
Here are my questions:
1. Has anyone used FrameReader to provide online books? What effort
was involved in providing them this way, as opposed to hardcopy.
2. What's your favorite way to provide online books? How much effort?
3. How long does it take to put together an online help system for
a fairly large software program. Do you think it's too ambitious
to try to ramp up on help authoring tools, put the system
together, and put out a major revision of a doc set in three
I will greatfully receive any other thoughts/suggestions you have
about putting out online documentation and help.