I always write a Use-Case document for the system under development and
choose between formal / informal depending on the size of the system and the
nature of the development.
I've found them to be a great way to define the fucntional requirements with
clients and its generally quicker to write one than to build a mock-up.
Writing Effective Use-Cases by Alistair Cockburn provides lots of excellent
guidance / examples. (Note that I said Use-Case document and not Use-Case
Diagrams, Use-Case Diagrams make nice content pages but they don't really
offer much else)
As for analysis / design I'll use pretty much anything from the UML toolbox
if its useful. But I'm not precious about it. The modelling exercise is
generally a means to an end (a well designed system) so a lot of it goes in
the bin when I'm finished. I'll generally keep anything that I think will
help the next developer get to grips with the system.
Cheers, Pete
----Original Message Follows----
From: Paul Roe <[EMAIL PROTECTED]>
Reply-To: [email protected]
To: [EMAIL PROTECTED], [email protected]
Subject: [CFCDev] Documentation
Date: Tue, 26 Jul 2005 10:47:28 -0700
I don't know about you guys but it's been a long time since I worked
from a requirements document or had a formal code review.
With that in mind I was wondering what everyone in this community does
to document their cf applicaitons. I know I could go through and
write the standard package of requirement docs and funny looking uml
diagrams, but what is really usefull? What do you guys do for
documentation and what do you find usefull when maintaining someone
else's code?
----------------------------------------------------------
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]
_________________________________________________________________
Winks & nudges are here - download MSN Messenger 7.0 today!
http://messenger.msn.co.uk
----------------------------------------------------------
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]
