Path: utzoo!news-server.csri.toronto.edu!cs.utexas.edu!usc!elroy.jpl.nasa.gov!decwrl!deccrl!news.crl.dec.com!shlump.nac.dec.com!subsys.enet.dec.com!cote
From: cote@subsys.enet.dec.com (Michael P.A. Cote)
Newsgroups: comp.object
Subject: Re: Documenting OO Systems
Message-ID: <20895@shlump.nac.dec.com>
Date: 8 Mar 91 13:42:40 GMT
References: <9103070342.AA07462@.nextserver.cs.stthomas.edu.cs.stthomas.edu..>
Sender: newsdaemon@shlump.nac.dec.com
Reply-To: cote@subsys.enet.dec.com ()
Organization: Digital Equipment Corporation
Lines: 53

My group started an OO based project a couple of months ago.  We spent
some time
trying to decide on a process for doing the development since OO was
completely 
new to the group.  After looking at the available CASE tools (Software
Through Pictures, 
Cadre Teamwork, and DECDesign) we decided that they did not provide us
with any real
benefit directly related to our OO process. (NOTE: Since that time these
products have
added some OO support).  

We decided that we would use a text based approach to documenting the
analysis and 
design of our system.  The diagrams that we do draw are done using a
free form drawing 
tool.  The diagrams are compatible with Booch's Class and Object
diagrams (Booch, OOD
with Examples, 1990).

The diagrams are further explained in the accompanying text where
needed.  In addition,
our analysis has identified classes that exist in the system.  These
classes are documented
using a documentation template which includes:
	Class Name
	Overview
	SuperClasses
	Attributes
	Relations
	Detailed Description

Since we are still in the analysis phase of the project, this
documentation provides only 
general words about how the object operates.

To document the design, we will baseline the analysis phase
documentation and then begin
transforming the class analysis to class design including defining
parameters and writing
PDL.  In addition, the design phase will document the overall
architecture of the system as
well as some other miscellaneous topics  such as startup and shutdown
issues.  In parallel 
with the design of the system we will be making a prototype as  a proof
of design.  

Our documentation is being written using VAX/Document

MPAC

Disclaimer: Opinions are mine and do not reflect any Digital Equipment
Corp. policy.