Re: Documenting an OO class library

Subject: Re: Documenting an OO class library
From: Laurie Rubin <lmr -at- SYL -dot- NJ -dot- NEC -dot- COM>
Date: Thu, 22 Dec 1994 09:06:40 -0500

I may be documenting similar info. in the next couple of months. I'd be
interested in the feedback on this one.
> I am looking for feedback on effective ways to document an object-oriented
> class library. This documentation:
> - Can be either online or paper-based
> - Is written for in-house staff of developers using Smalltalk to write
> business applications for real estate property managers

> Specifically, I am looking for answers to questions like:
> - What information about the classes do you include?
> - How do you get this information?
> - How do you format the information? What are your topic headings, etc...
> - How do you maintain the information?

> Thanks, Colleen Pars
> Senior Technical Writer; JMB Realty Corp.

Previous by Author: Mosaic as an online Help documentation viewing engine
Next by Author: Re: Grammar and usage
Previous by Thread: Documenting an OO class library
Next by Thread: Re: Documenting an OO class library

What this post helpful? Share it with friends and colleagues:

Sponsored Ads