John, You may want to look at some of the coding methods out there... Like fusebox. I use that and find it very useful in documenting etc. It would allow you to describe each template -- custom tags, etc. What is expected and what is to result -- you may want to take a look at it.
Now if you are wanting a more high-level document I think you're on the right track... Make sure you document your security and as many business rules as you can. I often find that if business rules aren't laid out they get forgotten, then they don't get implemented correctly down the road. The database won't be able to take care of every rule... The code will have some of that responsibility - business rules are important. Just my 2c. Good luck! Jason CFDynamics.com > -----Original Message----- > From: John Innit [mailto:[EMAIL PROTECTED]] > Sent: Monday, September 16, 2002 10:55 PM > To: CF-Talk > Subject: Re: HELP! with writing documentation. > > > > 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) > > > > > > > > > ______________________________________________________________________ Signup for the Fusion Authority news alert and keep up with the latest news in ColdFusion and related topics. http://www.fusionauthority.com/signup.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
