RE: comprehensive documentation


From: Chris Harrington (chris_h_at_kuri.com)
Date: 2002-08-29 00:45:01 UTC



I don't suppose one of your students feels like setting up a PHP server? Have any of you ever seen the documentation system over at http://www.php.net/manual/en/ ?

Granted the scope and subject matter are completely different, but their setup allows users to comment ( add to, correct, provide examples etc. ) on the documentation directly, which means that in the beginning only a framework documentation is necessary, the details being provided by the community. Certainly a change from the traditional method of a mishmash of websites and lists, but I would think perfect for an effort like host_ap which has generated so much interest. Also a great time saver, alleviating the requirement for everyone interested to expend the same effort ( redundant processes? ) looking around for the information. This would certainly translate directly into a dividend in less basic questions on the list?

> Jason Boxman wrote:> On Wednesday 28 August 2002 06:18 am,
> I can "semi-volunteer" some students enrolled in my software
> engineering
> class. Each must perform 5 hours of "community service" over
> the course
> of the semester, and such things as doing documentation of
> open source
> efforts counts and is encouraged.

-Chris Harrington



This archive was generated by hypermail 2.1.4.