Path: utzoo!utgpu!jarvis.csri.toronto.edu!mailrus!tut.cis.ohio-state.edu!bloom-beacon!apple!vsi1!wyse!mips!prls!philabs!linus!mbunix!bwk
From: bwk@mbunix.mitre.org (Barry W. Kort)
Newsgroups: comp.lang.smalltalk
Subject: Re: Presenting Smalltalk Code on Paper
Summary: How to represent a Smalltalk model on paper.
Keywords: Inheritance Hierarchy Diagram, Decomposition Hierarchy Diagram
Message-ID: <49070@linus.UUCP>
Date: 13 Apr 89 01:26:50 GMT
References: <5078@hubcap.clemson.edu>
Sender: news@linus.UUCP
Reply-To: bwk@mbunix (Barry Kort)
Distribution: na
Organization: The MITRE Corporation, Bedford, Mass.
Lines: 21

In article <5078@hubcap.clemson.edu> madhu@hubcap.clemson.edu
(M a d h u  Raman) writes:

 > The powers that be ...want my code documented on "Paper".  Other than
 > spewing out a meaningless printout, any suggestions on documenting on
 > "paper" so that the flavour of Smalltalk is not lost on the reader. 
 > 
 > With the browsers everything makes sense but how does one document 
 > the code on paper and still give the reader the same understanding?
 > Somebody must have tackled this problem about representation on paper. 
 > Any pointers or suggestions are most welcome.

Draw two diagrams.  First draw an inheritance hierarchy diagram
showing how the classes in your model are related with respect to
inheritance from their superclasses.  Then draw a decomposition
hierarchy diagram showing how your overall model is composed from
the classes.  Show the key messages between classes as arcs in the
decomposition diagram.  Annotate your diagram with a few sentences
explaining each class and each of the key messages.

--Barry Kort