[DOCS] Swiki as a reference manual?

Brent Vukmer bvukmer at blackboard.com
Fri Mar 7 18:43:30 UTC 2003


I like Andreas's idea A LOT.   A couple of thoughts:
--Caching locally is definitely needed, so that people can look at comments off-line.  
--The comments pane would have a "get latest comments version from the Swiki" button.
--The appropriate individual or groups (Docs team? Stewards? Harvesters? Guides ) should get notified when class comments changed.

-----Original Message-----
From: Douglas Brebner [mailto:squeaklists at fang.demon.co.uk]
Sent: Friday, March 07, 2003 1:26 PM
To: The general-purpose Squeak developers list
Subject: Re: [DOCS] Swiki as a reference manual?


On Fri, 7 Mar 2003 17:33:33 +0100
"Andreas Raab" <andreas.raab at gmx.de> wrote:
[snip]
> Since we use Swikis for this purpose already we have a pretty good
> feel how "outsider documentation" (by which I mean: documentation
> which hasn't been written by the original author) and to me, what's
> there is certainly better than what's in the image right now. So why
> not just go for the whole cake?! Simply declare the class comments to
> _be_ swiki pages (cached locally if you want to) and allow everyone to
> change them at will. You can still have all of the Swiki mechanisms
> (like locking pages etc) if you need to.

This will fail badly on machines without internet connections unless
you somehow have them cache the whole lot in advance.



More information about the Squeak-dev mailing list