Delivery of online help with a J2EE application

Subject: Delivery of online help with a J2EE application
From: Vanessa Vandervalk <vanessa -dot- vandervalk -at- mitratech -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 24 May 2006 18:59:04 -0700

Hello, I'm new to this site and hoping someone can help us. We are
delivering online help (HTML generated with WebWorks) for a software
application that is delivered as a WAR file and deployed on an application
server, such as Apache Tomcat or IBM WebSphere. Our HTML files have always
been built into the WAR file.

Our development team tells us that it is not standard for help files to be
embedded within the application itself. Now we are moving to a new
configuration, where the HTML files for our help will be delivered as a
separate WAR file. Our clients will have to deploy both the application and
the help WAR files in order for the help to be up and running. If the client
wants the help files to be served by their web server instead of the
application server, they change a parameter in the application's web
descriptor (web.xml) and put the HTML files on the web server.

Is this a typical configuration? We are worried about the additional
complexity and the possibility for our clients to not deploy the help WAR
file and thus have a broken link to the help system. If someone with
experience delivering online help in a similar environment could share their
experiences, we would really appreciate it.

Vanessa Vandervalk

Senior Technical Writer

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!.

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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 lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: Re: Documentation there really such a creature?
Next by Author: How to document algorithms?
Previous by Thread: RE: Maxit Simplified English
Next by Thread: Re: Delivery of online help with a J2EE application

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

Sponsored Ads