1 Nov 2009 03:58
Re: Designing and documenting in XP
zdnfa <zdnfa <at> yahoo.com>
2009-11-01 02:58:55 GMT
2009-11-01 02:58:55 GMT
--- In extremeprogramming <at> yahoogroups.com, "JeffGrigg" <jeffgrigg <at> ...> wrote: > > I still find a traditional Entity-Relationship Diagram to be quite useful: It serves as a road map to the database -- its tables and their relationships. I totally agree with you. We have used ERD, DFD, and Swimlane diagrmas in a government project and these diagrams helped a lot in drawing an initial pictiure to the system, and user stories were documented using these models. The nice thing is that this process helped in bringing up a common understanding amongs users themselves. > > It can easily take several man-days to get an ERD into really usable form, even with good tools to generate the basics of it. But it serves as a shared structure to guide discussion and design. > > I've seen that some people try to draw these ad-hoc, as needed. But that requires either memorization of all the content, which takes months and is unreliable, or regular repeated rediscovery of the information. We also found that a reverse engineered code into use case after every release is very helpful in creating a project documentation repository that helped in up coming releases. > > > I've found some other diagrams useful too: Generally speaking, something that gives you a high level overview of the system, a "road map" is likely to be useful. > > > The failure I've seen in document-driven projects is the idea that you must document everything that can be documented. Aside from consuming excessive resources to create and maintain such documentation, they create the problem of how can you find the documentation you need, buried deep inside large stacks of largely useless drivel. >(Continue reading)
RSS Feed