Providing fully customizable online Help

Subject: Providing fully customizable online Help
From: "Lorraine Butchart" <Lorraine -dot- Butchart -at- corel -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 17 Sep 2002 17:41:39 -0400



I have become involved in a project creating a highly customizable
content editor ("authoring environment"--how's that for
marketing-speak), and part of what we want client developers/customizers
to be able to customize is the online Help. The editor and its core Help
file as shipped will be extremely basic, but customizers/developers will
be able to create an end-use editor as simple or as complex as required
for their situation or organization, complete with forms, dialog boxes,
and menu commands that we would never have foreseen.

Currently, we provide online Help in HTML (.chm) format with our
products, and have in the past included brief instructions for using MS
HTML Help Workshop to create a customized help file and merge it with
our help file. This, however, can be a pretty unwieldy process for the
average non-tech-writer to have to navigate alone--so much so that most
customizers and developers haven't bothered to customize the help,
leaving the end-use authors with little or no help using the product as
customized. For this reason, we are hoping to find some format or tool
that we can use to create truly customizable online Help, where
customizers can add their own topics with a minimum of fuss. (Being able
to annotate existing help topics or change the names of fields would not
go far enough--we need client developers to be able to create entire
topics and sub-topics.)

Has anyone on the list worked on a similar project in the past? If so,
how did you address this issue? I would appreciate any tips or guidance
you can provide.

Lorraine L. Butchart
Documentation Specialist

Corel Corporation
Vancouver Office
phone: (604) 430-1966 Ext 4429
e-mail: Lorraine -dot- Butchart -at- corel -dot- com




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! http://www.ehelp.com/techwr-l

Acrobat & FrameMaker Seminars: PDF Best Practices, FrameMaker-to-Acrobat
Advanced Techniques, FM Template Design, Single Sourcing with FrameMaker
in Brussels (Oct), and in Montreal & Dallas (Dec): http://www.microtype.com/1

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: What does d.o.e. mean?
Next by Author: RE: Providing fully customizable online Help? (Take II)
Previous by Thread: Re: Documenting field descriptions in printed documentation
Next by Thread: Re: Providing fully customizable online Help


What this post helpful? Share it with friends and colleagues:


Sponsored Ads