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: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
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.
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. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-