Squeak Documentation Project

Stephane Ducasse ducasse at iam.unibe.ch
Thu Feb 6 10:47:32 UTC 2003


I think that all the effort to **externalize documentation** are 
Please consider to have documentation inside the image in a 
****synchronized*** manner.
Documentation will be obsolete just after you wrote it. Believe me, I 
worked in reengineering.

The only way to go for squeak is to write tests runnable executable 
tests. Look at the great test suites for uuid. Or for digit 
manipulation. I do nothing about bitshift but I can read the tests and 
understand that ((1 biftShift: 100) biftshift: -100) = 1 is right.

Again you see that tests DOCUMENT the interface of the objects.

If you do not understand uuid like me just read them and you will see 
that you will get a precise idea of uuid. So writing documentation as 
SUnit is the only way to have documentation inside the image that will 
be ***always in sync*** with the image and ***CRUCIAL*** those Tests 
will support the possibility to change Squeak.

Note that the tests will also help the harvesters too.
So if you want to participate into documentation write tests in Sunit. 
There is a tutorial on SUNit I translated for that purpose

But the squeakers prefer to hack apparently. This is just too bad.


On Thursday, February 6, 2003, at 10:57 AM, Bernd Oldenbüttel wrote:

> Am Donnerstag, 6. Februar 2003 10:13 schrieb Chris Burkert:
>> There was squeakdoc.org why is it closed ? Who did it ? This would be 
>> a
>> great starting point, wouldn't it ?
> I did it. And I closed it because after one week (and some test 
> entries) there
> was no activity (not counting spiders). For a while I tinkered with a 
> morphic
> frontend to SqueakDoc, but ... Well, a bit more Documentation would 
> have been
> welcome. :-)
> If you want to try it again, I promise to help as much as I can.
> Bernd
> -- 
> <e>werk GmbH
> Bernd Oldenbüttel
> Langenstr. 75
> 28195 Bremen
> tel 0421-33513-68
> fax 0421-3351-65
Prof. Dr. Stéphane DUCASSE (ducasse at iam.unibe.ch) 
  "if you knew today was your last day on earth, what would you do
  different? ... especially if, by doing something different, today
  might not be your last day on earth" Calvin&Hobbes

More information about the Squeak-dev mailing list