Re: User commentary in docs
| From: | Robert P. J. Day | Date: | Tue, 06 Apr 2010 16:41:06 +0000 |
| Subject: | Re: User commentary in docs | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969381565@lists.php.net to get a copy of this message | ||
On Tue, 6 Apr 2010, Rich Bowen wrote:
> A few of us on the Apache HTTP Server documentation team are
> investigating what it would take to add a user commentary system to
> the Apache HTTPD docs, like that used on the PHP docs. What software
> is used for that? Is it easily reusable in other places? Where can I
> get some more info about it?
please reconsider that idea. as it is, there's simply too much
nonsense that's been added by users at the PHP docs site. here's an
example:
http://www.php.net/manual/en/language.variables.php
if you look closely at that page, it's simply a ***table of
contents***, fer cryin' out loud. nevertheless, numerous commenters
found it necessary to expound on it. for what conceivable purpose?
if you want to support user commentary, the only sane way is to
regularly peruse those comments, trash the garbage, and incorporate
the reasonable comments into the documentation proper. just leaving
the comments there in perpetuity is, IMHO, a terrible idea.
rday
--
========================================================================
Robert P. J. Day Waterloo, Ontario, CANADA
Linux Consulting, Training and Kernel Pedantry.
Web page: http://crashcourse.ca
Twitter: http://twitter.com/rpjday
========================================================================