Re: Re: Livedocs

From: Date: Mon, 23 Feb 2004 17:51:20 +0000
Subject: Re: Re: Livedocs
References: 1 2 3 4 5 6  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-25822@lists.php.net to get a copy of this message
Arnaud Limbourg wrote:
I didn't mean it like that. More like Javadoc or phpdoc type comments right in the source code files. Having separate documentation files in the project tree isn't much better than having them in a separate site.
Yes, but this kind of documentation is not enough. This topic has been discussed before but what comes out is that phpdoc is nice for developpers. End-users need other type of docs, tutorials, quick start, younameit.
There's a fundamental point here. Aren't PEAR end-users all developers? We don't need those "Teach Yourself In 21 Days" 15kg books for PEAR. All that's needed is a kickstart tutorial and up to date reference. I personally don't need anything else to use a library (bar examples, which come in handy when evaluating alternatives). I'd be very very glad if all PEAR packages had these minimum-level docs. A very big lot doesn't have a line of documentation... Sérgio

Attachment: [application/pgp-signature] OpenPGP digital signature signature.asc
« previous php.pear.dev (#25822) next »