[ANN] Squeak Documentation Project
Lex Spoon
lex at cc.gatech.edu
Wed Sep 27 06:54:05 UTC 2006
tim Rowledge <tim at rowledge.org> writes:
> On 25-Sep-06, at 5:18 AM, Lex Spoon wrote:
> [snip]
> >
> > Thus, forgive me if I think people may be misunderstanding what is
> > already available. Writing up a bunch of HTML documenting individual
> > methods and classes does not make sense for Squeak.
> >
> > Instead, it makes sense to concentrate on two other areas:
> >
> > 1. Improving Squeak's own self-documentation. Many methods
> > and classes are not documented.
>
> Exactly; in-code documentation needs lots of work
>
> >
> > 2. Write articles with broader scope. If you want to know what
> > the methods of Canvas are, then look in your image. If you want to
> > know how Canvas fits into the Morphic architecture, then you need
> > to read a broader article about Morphic (e.g., the chapter in the
> > "nu-blue" book).
>
> ...and don't forget an article/tutorial on using the tools so that
> new users are able to look in the image for the improved class
> comments. Teaching about effective use of the tools is almost as
> important as providing a good basis for understanding objects and
> messages.
Absolutely. You'll be as happy as I to know that on page number
*four* on the Squeak swiki -- i.e., the third page created after its
creation -- you find information about how to use all of the built-in
Squeak development tools plus a few optional ones.
http://minnow.cc.gatech.edu/squeak/4
-Lex
More information about the Squeak-dev
mailing list
|