Squeak Documentation Project

Brent Vukmer bvukmer at blackboard.com
Thu Feb 6 15:11:32 UTC 2003

Goran I think a "magic book" inside Squeak would be very, very cool.  

I imagine it like this, for each version of Squeak:

Package in Squeak/SqueakMap ( Networking, Morphic, etc. ) -> Test cases
-> Section in magic book   

Also I picture each section in the book as a Project that has been
registered on SqueakMap. I envision the book section being updated by
the Documentation team for every new release of the package with which
it is associated.  

-----Original Message-----
From: goran.hultgren at bluefish.se [mailto:goran.hultgren at bluefish.se]
Sent: Thursday, February 06, 2003 8:19 AM
To: The general-purpose Squeak developers list
Subject: Re: Squeak Documentation Project

Stephane Ducasse <ducasse at iam.unibe.ch> wrote:
> >
> Hi goran
> I agree with what you said previously.
> > What do you think Stephane?
> Could be cool, I do not kknow exaclty we could present Sunit tests in
> more digestable way.

I didn't really mean to present the test code itself. Rather I meant
(for example) that this "interactive book" - which would contain stuff
much like any manual/book would like examples, explanations, the "big
pictures" etc - would have each little part of it's content "tied" to
one or more test cases.

This would mean that whenever a test case is broken OR altered (changed
OR enlarged) the corresponding part in the book would automatically turn
"stale" until someone actively goes in - looks it over - and verifies
that it is still up to date (marked with name and timestamp of course,
otherwise it may get tempting to just mark it "ok" without even

The idea being that we can then "force" the book to stay up to date.

More information about the Squeak-dev mailing list