The documentation for the application that I work with is kind of sparse (I inherited it), but two things I've added recently is a couple of perl scripts that spider all the code and document the database activity (all queries, what tables they it, etc.), and a dynamically created link map for the entire site. I find these invaluable when deciding how to change sections of the site, because they help me see me what impact the change will have to other pages and sections.
> -----Original Message----- > From: [EMAIL PROTECTED] > [mailto:[EMAIL PROTECTED] On Behalf Of Paul Roe > Sent: Tuesday, July 26, 2005 11:47 AM > To: [EMAIL PROTECTED]; [email protected] > Subject: [CFCDev] Documentation > > I don't know about you guys but it's been a long time since I worked > from a requirements document or had a formal code review. > > With that in mind I was wondering what everyone in this community does > to document their cf applicaitons. I know I could go through and > write the standard package of requirement docs and funny looking uml > diagrams, but what is really usefull? What do you guys do for > documentation and what do you find usefull when maintaining someone > else's code? > > > ---------------------------------------------------------- > You are subscribed to cfcdev. To unsubscribe, send an email > to [email protected] with the words 'unsubscribe cfcdev' as > the subject of the email. > > CFCDev is run by CFCZone (www.cfczone.org) and supported by > CFXHosting (www.cfxhosting.com). > > CFCDev is supported by New Atlanta, makers of BlueDragon > http://www.newatlanta.com/products/bluedragon/index.cfm > > An archive of the CFCDev list is available at > www.mail-archive.com/[email protected] > > > > [INFO] -- Access Manager: This transmission may contain information that is privileged, confidential and/or exempt from disclosure under applicable law. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution, or use of the information contained herein (including any reliance thereon) is STRICTLY PROHIBITED. If you received this transmission in error, please immediately contact the sender and destroy the material in its entirety, whether in electronic or hard copy format. Thank you. A2 ---------------------------------------------------------- You are subscribed to cfcdev. To unsubscribe, send an email to [email protected] with the words 'unsubscribe cfcdev' as the subject of the email. CFCDev is run by CFCZone (www.cfczone.org) and supported by CFXHosting (www.cfxhosting.com). CFCDev is supported by New Atlanta, makers of BlueDragon http://www.newatlanta.com/products/bluedragon/index.cfm An archive of the CFCDev list is available at www.mail-archive.com/[email protected]
