We have to have up to date documentation on our web projects. They actually can not go into production until those docs are made. With that said, things sure do manage to slip through the cracks. The master documentation though is a good piece for the project managers to see and look over, that way they know things have been documented because they are not going to spend the time to read through all of the code. The documentation will include not only the CF, but any SQL related information such as DTS or SP information. After coming into projects behind developers many times in the past, I personally like being able to read through a master document on the project/site as well as see comments in the code. We also do use a standard methodology here on the intranet applications, but things can still be confusing to figure out if you have no comments or docs.
Snipe - <CF_BotMaster Network="EFNet" Channel="ColdFusion"> On Fri, 22 Feb 2002, Alex wrote: > 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 numb er > > , > > 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 applicatio ns > . > > > > 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 applic at > > 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/cf-talk@houseoffusion.com/ Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
