Need advice on standardizing documentation in a project
in [OOP]
|
Prev: Need advice on standarizing documentation in a project
Next: Is Procedural Paradigm a basis of OO Paradigm?
From: flo on 21 Feb 2007 05:41 Hi all: this is pretty much a typical situation in every book in OOA/D however come to the practice the implementation is cumbersome. this project has grown from one to four developers, there's no standard documentation or documentation at all except for a few written documents in business level, how can we move from that scenario to one where there is standard documentation, there is a design phase, etc. I am lost, any guidelines more than welcome.
From: Nick Malik [Microsoft] on 24 Feb 2007 01:36
Big documents are a time-waster. However, no documents are a free-for-all. Somewhere in the middle is useful. That spot can yeild some debate. I find that two artifact types are excellent for keeping folks on the "small and clear" document path: 1) Simple use cases. I'm really no fan of fully blown use cases (like Weigers professes). A use case can have a lot of details, and be very valuable, or it can be an open door through which you can drive a thousand hours that you will never get back. My favorite, all time, most useful analysis document: the use case survey. It is a list of the use case titles with a very short description next to each title. You can usually fit ten-to-fifteen items to a page. A truly complex system can be described in six pages. Doesn't get much lighter than that. 2) Model diagrams. UML2 is great. Static diagrams, Dynamic diagrams, Sequence, State, Deployment. I'm especially fond of diagrams that are tied to the code (generative). More can be said in a set of diagrams and two pages of text than in 200 pages of "functional spec" complete with screen shots of the user interface. Remember, the goal is to communicate to developers. Don't make the documents pretty. In fact, many teams don't use documents at all. 3x5 cards are popular for the user stories (like 'lite' use cases). Forces them to be small. -- --- Nick Malik [Microsoft] MCSD, CFPS, Certified Scrummaster http://blogs.msdn.com/nickmalik Disclaimer: Opinions expressed in this forum are my own, and not representative of my employer. I do not answer questions on behalf of my employer. I'm just a programmer helping programmers. -- "flo" <vopowl(a)gmail.com> wrote in message news:1172054468.512357.59750(a)p10g2000cwp.googlegroups.com... > Hi all: > > this is pretty much a typical situation in every book in OOA/D however > come to the practice the implementation is cumbersome. > this project has grown from one to four developers, there's no > standard documentation or documentation at all except for a few > written documents in business level, how can we move from that > scenario to one where there is standard documentation, there is a > design phase, etc. > > I am lost, any guidelines more than welcome. > |