Path: utzoo!utgpu!jarvis.csri.toronto.edu!mailrus!tut.cis.ohio-state.edu!ucbvax!ucsd!sdcsvax!trantor.harris-atd.com!x102c!rsimonian
From: rsimonian@x102c.harris-atd.com (Simonian RP 66449)
Newsgroups: comp.lang.smalltalk
Subject: Re: Presenting Smalltalk Code on Paper
Keywords: Any suggestions ?
Message-ID: <1925@trantor.harris-atd.com>
Date: 12 Apr 89 12:30:37 GMT
References: <5078@hubcap.clemson.edu>
Sender: news@trantor.harris-atd.com
Reply-To: rsimonian@x102c.harris-atd.com (Simonian RP 66449)
Distribution: na
Organization: Harris Corporation GSS, Melbourne, Florida
Lines: 27

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. 


We have a contract for the Tri-Services (Army, Navy, AF) where we are 
implementing an Automated Knowledge Acquistion tool in Smalltalk using,
believe it or not, full 2167 documentation standards.  The standards
are somewhat tailored, of course, but it's actually worked out quite
well.  If you are familiar with Government standards, we broke the 
system down into some high-level functional units (`CSCs'), such as the
help system, the system monitor, and so on.  Within each CSC, we followed
the 2167 standards for inputs, outputs, sequencing, and processing.

We are also providing class and method level details.  I wrote a documentation
generator (Smalltalk/V) which goes through a specified set of classes and
dumps out class and method information in a readable format, as you might
find in the Smalltalk/V reference manual.  Part of its job is to pull out
the first comment in a method.


Richard P. Simonian     407/984-6006
Natural Language Processing Group
Harris GISD, Melbourne, FL  32902             
Internet: rsimonian%x102c@trantor.harris-atd.com