Re: "waldschrotts guide to nifty references" - manualpage draft, version 0.9b
| From: | Zak Greant | Date: | Sat, 19 Aug 2000 23:00:27 +0000 |
| Subject: | Re: "waldschrotts guide to nifty references" - manualpage draft, version 0.9b | ||
| References: | 1 2 | Groups: | php.dev |
| Request: | Send a blank email to php-dev+get-29740@lists.php.net to get a copy of this message | ||
God forbid that the PHP manual comes to resemble most man pages! :)
Why are we having this discussion?
Shouldn't we be deciding what is wanted and needed before we go arguing
about what the manual is?
The manual is the product of evolutionary development - much more so than
planning. If someone had time, expertise and interest, then they modified
the manual.
Evolutionary development can make some fantastic things - and these things
often meet the needs of their end users quite well.
However, it takes a long time without a plan. Can we stop and decide what
we want to engineer for documentation?
- zak
> De-facto, the manual has always been treated as a reference manual, and
not
> a user's guide. I don't see tutorials being a part of it ever; Many
> people have written good tutorials, and we never thought about importing
> them into the manual, which is good. Would you expect to see tutorials in
> UNIX man pages? Neither would I.
>
> Zeev
>
> At 01:42 20/08/2000, Rasmus Lerdorf wrote:
> > > No it is *not* users guide. It is reference manual. If you want user's
> > > guide, fine, but it's not the same as reference manual. And they
should be
> > > different, because they serve different purpose. In this case, we need
two
> > > documents, and making existing reference manual into user's guide only
to
> > > struggle afterwards to get reference manual back would be a clean
waste of
> > > time and effort.
> >
> >What makes you think the online manual is only a reference manual? It
> >doesn't say "Reference Manual" anywhere. It says "PHP Manual".
> >It
> >includes a section called "Language Reference" and it includes another
> >section called "Function Reference", but there is a reason that these are
> >individual sections. If somebody wants to write some good tutorials
> >explaining various concepts in PHP, then they will be added. Have a look
> >through the things in the "Features" section of the manual.
> >
> >-Rasmus
> >
> >
> >--
> >PHP Development Mailing List <http://www.php.net/>
> >To unsubscribe, e-mail: php-dev-unsubscribe@lists.php.net
> >For additional commands, e-mail: php-dev-help@lists.php.net
> >To contact the list administrators, e-mail: php-list-admin@lists.php.net
>
> --
> Zeev Suraski <zeev@zend.com>
> http://www.zend.com/
>
>
> --
> PHP Development Mailing List <http://www.php.net/>
> To unsubscribe, e-mail: php-dev-unsubscribe@lists.php.net
> For additional commands, e-mail: php-dev-help@lists.php.net
> To contact the list administrators, e-mail: php-list-admin@lists.php.net
>