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:Building Doc/Help in PC?Windows environment From:Jan Stetson <jks -at- CONCENTRA -dot- COM> Date:Wed, 1 Mar 1995 15:13:35 +0500
We're looking for some words of wisdom...
We've been using FrameMaker in a UNIX workstation environment for
several years to document a UNIX workstation based software system.
We recently moved the documentation online with FrameViewer.
Now, development is working on a new PC and Windows based product
line. We in documentation are exploring options for providing online
documentation and help in the PC windows environment. We expect to
implement documentation and help as two separate systems.
We're feeling a bit like babes in the woods, as none of us really has
much PC experience, even as users.
We currently rely rather heavily on Frame batch processing and
manipulation of MIF files using both UNIX shell programs and programs
in C to automate the drudge aspects of maintaining the doc set. We
would like to exploit whatever potential for automation exists in the
PC environment.
Also, in both PC and UNIX environments, we expect to provide language
and conceptual documentation, not exclusively using and user interface
information.
Some of our questions:
Is there a standard doc/help viewing mechanism for this environment?
What is it?
Is there more than one?
Is there a standard doc/help toolkit or interface builder?
What is it?
Is there more than one?
What are the pros and cons of different systems?
Is a FrameMaker/FrameViewer system out of the question?
Development is using windows NT as a development environment. Should
we consider doing the same?
Is there a FAQ or archive or other already assembled body of
information that addresses this topic?
We would greatly appreciate any information to help us make informed
choices. Personal experiences, pointers to books or other resources.
Whatever.
Thanks much,
---------------------------------------------------
Jan Stetson Concentra Inc.
jks -at- concentra -dot- com 201 Broadway
Cambridge, MA
---------------------------------------------------
