Re: FYI - Fwd: Re: [PHP-DOC] How to manage notes?

Sounds good. I'm one of the main note editors, so I pretty much knew all of this, and the current people that delete/reject notes seem to know what they're doing too (there's about 3 regulars on the notes list). Thanks for the message. --Andrew On Sat, 2003-05-03 at 14:45, Jesus M. Castagnetto wrote: > Here is the most current copy of the notes editing > 'rule of thumb' guidelines I found in my mailbox. > > --- "Jesus M. Castagnetto" <jmcastagnetto@yahoo.com> > wrote: > > Date: Sat, 24 Aug 2002 01:29:42 -0700 (PDT) > > From: "Jesus M. Castagnetto" > > <jmcastagnetto@yahoo.com> > > Subject: Re: [PHP-DOC] How to manage notes? > > To: Victor <vboivie@home.se>, phpdoc@lists.php.net > > > > Hi Victor, > > > > --- Victor <vboivie@home.se> wrote: > > > Hi everybody, > > > > > > I hope I'm posting in the correct group now. > > > > Nope, the correct group is php-notes, you need to > > subscribe to that list by sending an email to: > > > > php-notes-subscribe@lists.php.net > > > > > > > > I joined the PHP development team to be able to > > > clean up a little among all > > > notes, and to create a better system once I know > > how > > > everything works. I > > > have some questions that I need to have answered > > > though: > > > > > > 1. When do we remove/reject news? What is our > > > quality treshold? (There might > > > be something good in every note, but should our > > goal > > > be to have only great > > > notes in the manual, or everything that could > > > possibly help the other > > > users?) > > > > Here is a "rule of thumb" (from Jim Winstead): > > > > "... > > if it is a bug, or a plea for help, reject it. the > > submitter will get a > > nice email telling them how to submit a bug or ask > > for > > help. > > > > if it contains useful information, incorporate that > > into the docs > > yourself, and then delete it. (if you are not able > > to > > incorporate it > > into the documentation yourself, leave it alone for > > someone else to > > handle.) > > > > if it is misplaced, or wrong, or is a giant block of > > silly code, or > > poorly written, or an answer to a question some else > > asked, delete it. > > (and for the last one, hunt down the question and > > reject it.) > > > > jim > > > > ..." > > > > > 2. What is the difference between rejecting and > > > removing a note? (is an > > > email sent when we reject, or?) > > > > Well, the main difference is that only when a > > rejection happens an email is sent to the original > > note poster. At some point I added the rejection > > option and later Jim improved it greatly, so now you > > can do edit/delete/reject from the email you get > > when > > subscribed to the notes list. > > > > > 3. Is there a "handbook" for PHP developers that I > > > should read? > > > > The PHP manual for all things PHP, and of course the > > source code from (at least) the php4 dir on cvs > > (cvs.php.net), and even better if you also are in > > the > > documentation team (this list is for that). > > > > > Or if someone would like to explain in detail how > > > this work is performed, > > > I'd be very happy. > > > > > > Regards, > > > Victor > > > > Hope the info above starts you up. For more details > > or > > if you are in doubt, subscribe to the notes list and > > ask us there. Check also the archives at > > news.php.net > > to get an idea of the volume of notes and how some > > situations are handled. Usually if you do not know > > something (or are in doubt about a particular note), > > email the notes list requesting opinions and surely > > someone will help. > > > > If you have the time, you can start by cleaning up > > the > > manual pages w/ a lot of notes. There are many > > old/outdated/incorrect ones. > > > > > > ===== > > --- Jesus M. Castagnetto <jmcastagnetto@php.net> > > > > __________________________________________________ > > Do You Yahoo!? > > Yahoo! Finance - Get real-time stock quotes > > http://finance.yahoo.com > > > > ===== > --- Jesus M. Castagnetto <jmcastagnetto@php.net> > > __________________________________ > Do you Yahoo!? > The New Yahoo! Search - Faster. Easier. Bingo. > http://search.yahoo.com -- Andrew Lindeman <alindeman@php.net>