Help for web application

Subject: Help for web application
From: Frank Dissinger <dissinger -dot- cgs -at- gmx -dot- de>
To: TechWrite List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 03 Apr 2008 16:01:10 +0200

Hi all,

My company is developing a web-based help application for which I will
have to provide some kind of user assistance. It has not been specified
how this should be done. I would like to supply ideas and suggestions,
thus hoping to avoid that this issue is left to our developers...

Unfortunately I have no experience with help for web-based applications.

Which designs and techniques can I use? Help pane embedded in
application window? Button loading help file in separate window?
Popups? Are there any best practices or sample web pages?
Which tools should I use? How do I link topics with a web page?

Until now I have produced context-sensitive CHM files with FrameMaker
(V. 6.0) and WebWorks Publisher (V. 7.0.6). I am also considering the
use of Flare.

Any ideas will be greately appreciated.


Frank Dissinger · /Technical Writer/

CGS Publishing Technologies International GmbH
Kettelerstr. 24 · 63512 Hainburg · Germany

info -at- cgs -dot- de ·

Phone: +49 (0) 6182 9626 0
Fax: +49 (0) 6182 9626 99

Commercial register: Offenbach, HRB no. 21495
Managing directors: Trevor Haworth, Jan de Maeyer, Andreas Kämmerer


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: Replacing "master" and "slave" terminology
Next by Author: RE: Significance of Document Numbering?
Previous by Thread: RE: How do you define your audience/"user requirements" in your docs, to the reader?
Next by Thread: RE: Help for web application

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

Sponsored Ads