My question, or really concern is building application documentation to accompany delivery of a project. Code documentation is very straight forward.
Currently, I'm trying to build some samples to use as a model for our ongoing and future development. The IEEE standard is cumbersome to say th e least. For now, I'm essentially writing a narrative that combines the functional spec with key elements of the technical spec, but I'm working in a void. It would be helpful if anyone has some content they might be willing to share. This would help me determine what useful elements I might be overlooking, or more effective ways of communicating information. My premise has been to provide documentation such that if everyone who worked on the project in our organization, and everyone that uses the application on the client end where fired tomorrow. Our replacements woul d have a complete picture of the application use and function. Trey Rouse Internet Project Coordinator Web Services - Rice University -----Original Message----- From: Alex [mailto:[EMAIL PROTECTED]] Sent: Friday, February 22, 2002 1:54 PM To: CF-Talk Subject: RE: Documentation 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 > > ______________________________________________________________________ Why Share? Dedicated Win 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=coldfusionc 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
