Re: User commentary in docs
| From: | Stelian Mocanita | Date: | Tue, 06 Apr 2010 17:11:44 +0000 |
| Subject: | Re: User commentary in docs | ||
| References: | 1 2 3 4 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969381575@lists.php.net to get a copy of this message | ||
Hello everyone. The user notes is a great resource to most new users.
However there are snippets of junk there that are not only useless, but they
even get confusing at some time. I think there would be great to start a
program of checking such comments, I can help if needed (not yet involved in
this in any way).
Another opinion would be all the notes removed from the doc page and add
into a "read user feedback" sub-page so whoever needs it can access it, or
simply allow comments for certain kind of pages.
-- Stelian
On Tue, Apr 6, 2010 at 8:01 PM, Rich Bowen <rbowen@rcbowen.com> wrote:
>
> On Apr 6, 2010, at 12:56 PM, Philip Olson wrote:
>
> 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.
>>>
>>
>> That's was the original idea, and once worked well. However, over time we
>> started leaving information that looked remotely useful so it's grown [out
>> of control]. And besides, it's difficult to know what a proper user note is
>> as I reckon we all have different definitions. And over time users have come
>> to expect the user notes as is, which are remotely related tips and code
>> snippets. I think simply removing them all would cause the PHP world to
>> crash upside down. :) All thoughts and ideas welcome.
>>
>
> I think that in an ideal world, the comments all get integrated, and then
> deleted. This is impractical, given the sheer scope of the problem, but it's
> an ideal to strive towards, and an excellent place to point folks who want
> to get involved in the documentation process.
>
> --Rich
>
>