Write good comments and if necessary have a small README file with the app. Documentation is always out of sync with the current code and IMO never read anyway.
On Fri, 22 Feb 2002, Ian Lurie wrote: > I like fusedoc for code documentation. > > For actual specs, I prefer the IEEE standard. I can't remember the number > , > I'm afraid, but it's very thorough... > > -----Original Message----- > From: Trey Rouse [mailto:[EMAIL PROTECTED]] > Sent: Friday, February 22, 2002 11:24 AM > To: CF-Talk > Subject: Documentation > > > I've been tasked with creating a documentation model for our applications . > > I'm curious if anyone has some examples of what they are doing they may b > e > willing to share off list, or if anyone uses an industry standard they co > uld > direct me to. > > I'm speaking in a scope of not just code documentation, but hard applicat > ion > documentation. > > Thanks, > > Trey Rouse > Internet Project Coordinator > Web Services - Rice University > > ______________________________________________________________________ Dedicated Windows 2000 Server PIII 800 / 256 MB RAM / 40 GB HD / 20 GB MO/XFER Instant Activation � $99/Month � Free Setup http://www.pennyhost.com/redirect.cfm?adcode=coldfusiona FAQ: http://www.thenetprofits.co.uk/coldfusion/faq Archives: http://www.mail-archive.com/[email protected]/ Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
