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.
> I've been offered a contract to produce on-line documentation for an application
> designed to work on multiple platforms. ... A single set of files is required
> which will run on all browsers without the need to use Java.
> May I please have advice on which writing tool would be the most effective to
> produce the documentation for this application?
One obvious possibility is to just do the whole thing in HTML. I have a set of
docs done that way (www.freeswan.org) using plain old text editors (vi and
Wordpad) for all the editing.
You might prefer a different way to edit. A check through list archives will
turn up a number of conversations about HTML editors and, in particular, which
ones produce clean HTML usable across platforms.
Conside Amaya, the free integrated browser/editor from w3c.org.
If you need other formats for output from HTML files, have a look at htmldoc,
a free download (but they charge for support) from www.easysw.com. From a set
of HTML files, it can produce:
HTML files with previous/contents/next links plus contents file
one big HTML file with table of contents
PDF with handy navigation bar
I find it easy to use and it works reasonably well. However, I had user
complaints about font tags it added, I don't like those myself, and did
not find an easy way to disable that feature. I therefore wrote a sed
script to trash those tags. It is in the FreeS/WAN distribution, under a
GPL license, if you need it.
Depending what other requirements you have or anticipate, and what tools
you prefer working with, you might also do this using some single source
method that outputs HTML and other formats from some standard source form.
Consider at least DocBook XML (www.docbook.org for info and www.linuxdoc.org
for examples) and Framemaker if you want to go this route. An archive search
will likely turn up many more possibilities.
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.