John,
I found a well documented documentation process to be fusedocs. Check out the
fusedocs chapter from the New Riders fusebox book my Nat Papovich and Jeff Peters.
It's well written and does a great job of explaining fusedocs and some tools to extend
them. If anything, it'll give your a good jumping off point to develop and document
your own documentation process.
cheers,
t
p.s. - in case any of my friends see this, I'm definitely not saying to use fusebox at
all! just check our fusedocs.
-----Original Message-----
From: John Innit [mailto:[EMAIL PROTECTED]]
Sent: Mon 9/16/2002 8:57 PM
To: CF-Talk
Cc:
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)
______________________________________________________________________
Structure your ColdFusion code with Fusebox. Get the official book at
http://www.fusionauthority.com/bkinfo.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
