We have a pretty extensive SDLC procedure where we work - My role is as a technical developer, so I get to skip all that annoying business documentation.
Such that I end up writing a general Architectural overview, including machines, IPs and Domains, integrated interfaces and applications. We then have a technical design document that goes into most of everything - class and package diagrams, explanations of what each component in the system does, and even pseudo code on each component (which i think is a waste of time, because good code should be readable). This also includes documentation for build scripts, testing, and deployment. Each enhancement on an application also has it's own documentation, outlining the changes to each component in the system, and the build scripts, test script and implementation details. It can be a royal pain in the ass to write... but if you are inheriting an application, it can be a g-dsend. Mark On 7/27/05, Haikal Saadh <[EMAIL PROTECTED]> wrote: > Those scripts sound useful. Are you willing to share them with us? > > Munson, Jacob wrote: > > >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. > > -- E: [EMAIL PROTECTED] W: www.compoundtheory.com ICQ: 3094740 ---------------------------------------------------------- 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]
