[thelist] Documentation best practices?

Johnson, Christopher (MTO) Christopher.Johnson at mto.gov.on.ca
Wed Jun 9 10:17:13 CDT 2004

First question that must be asked is what language are you dealing with?
Some languages come with Documentation features and practices built in,
i.e., java has javadoc. for C, C++ you can use DOxygen (similar to javadoc).

One suggestion that seems to work for some is to use a wiki for the
documentation. This way, anyone who works on the project is able to quickly
and easily update the documentation.


-----Original Message-----
From: Joel Konkle-Parker

The application in question is multiplatform, and so must be the
I'm somewhat attracted to the HTML idea, but I'm not sure if this is the
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.

More information about the thelist mailing list