Actually we are getting the documentation written for us, and as we have never done this before we want to make sure we get it done properly. The docs should be sufficient in that a party developer would quickly get an understanding of our site. For example some of the basic things we are documenting include the database schema, list of tags used, basic functionality's and work flows. I'm just looking for general advice on things we should make sure are covered in the docs!!
At 12:18 PM 9/17/2002, you wrote: >That info is usually very proprietary. You have to take the time to develop >your own >standards. > >L Marcus > >----- Original Message ----- >From: "John Innit" <[EMAIL PROTECTED]> >To: "CF-Talk" <[EMAIL PROTECTED]> >Sent: Monday, September 16, 2002 11:57 PM >Subject: need help with creating documentation for our CF APP > > > > We're creating documentation for a CF based web site. The documentation > > should allow other developers to understand our application and > > functionality. In the event of us needing third party application support > > or in hiring new developers we want to ensure that our site is well >documented. > > > > My question is what are the best practices, what should we cover, can > > anyone share any basic conventions or standards for documentation? > > > > Thanks. > > > > > > > > > > "The only difference between me and a madman is that I'm not mad." > > - Salvador Dali (1904-1989) > > > > > ______________________________________________________________________ Your ad could be here. Monies from ads go to support these lists and provide more resources for the community. http://www.fusionauthority.com/ads.cfm 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
