[thelist] Documentation best practices?

chris lists at semioticpixels.com
Thu Jun 10 18:14:26 CDT 2004

Joel, you might want to look at docBook http://www.docbook.org/ 

If docbook is overkill, then writing your documentation in xml is probably a
good idea for uncertain multiple formats and platforms.


-----Original Message-----
From: thelist-bounces at lists.evolt.org
[mailto:thelist-bounces at lists.evolt.org] On Behalf Of Joel Konkle-Parker
Sent: Wednesday, June 09, 2004 1:35 AM
To: thelist at lists.evolt.org
Subject: [thelist] Documentation best practices?

I've been given the task of documenting a software package, and I'd like
some feedback about what are considered some modern best practices for such
a thing.

First of all, is there a group or forum or something that discusses these
issues? I did a google/google groups search, but didn't come up with

The application in question is multiplatform, and so must be the
documentation. I'm somewhat attracted to the HTML idea, but I'm not sure if
this is the best way to go. PDF is also an option. I've also heard of
meta-languages that let you mark up and expand to different formats from
there, but I have no experience with such things.

Any advice?

Joel Konkle-Parker
Webmaster  [Ballsome.com]

E-mail     [jjk3 at msstate.edu]
Phone      [662-518-1636]
* * Please support the community that supports you.  * *

For unsubscribe and other options, including the Tip Harvester 
and archives of thelist go to: http://lists.evolt.org 
Workers of the Web, evolt ! 

More information about the thelist mailing list