This sounds like a great way to augment documentation, but I still like class and method comments - Stef might want to work on the train :) Various things mentioned here recently (such as threading) will hopefully get chapters in PBE.
Bill -----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of Adrian Kuhn Sent: Thursday, December 31, 2009 10:17 PM To: [email protected] Subject: Re: [Pharo-project] Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse. Adrian Lienhard <a...@...> writes: > What about using a wiki to gather and edit comments (as suggested by > Stan) and then integrate them in a second step so that they are kept > together with the code (as suggested by Stef)? Just a thought... That gave me an idea, what about structuring that wiki like the discussion pages of wikipedia? That is, the wiki is structured by classes and methods, and in the image the browser shows a [wiki] button for classes and methods everywhere. This decouples publishing of code (functional contributions that you want to have double checked and tested by a core member) from publishing of comments (where like on wikipedia everyone can contribute without much harm). Also no dull work required to review and brush up all the information. Of course, initial effort is setting up a wiki with URLs of form /wiki/classname/methodname and including a button in OB that opens the wiki. --AA _______________________________________________ Pharo-project mailing list [email protected] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project _______________________________________________ Pharo-project mailing list [email protected] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
