Re: On PEAR quality issues and natural selection
| From: | Martin Jansen | Date: | Fri, 09 Apr 2004 16:10:05 +0000 |
| Subject: | Re: On PEAR quality issues and natural selection | ||
| References: | 1 2 3 4 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-27253@lists.php.net to get a copy of this message | ||
On Fri Apr 09, 2004 at 06:0104PM +0200, David Costa wrote:
> The Docs format might be a problem (aka you need to spend some time to
> learn it)
> but I also noticed that some developers host the full and detailed
> documentation on their own site.
> Is this allowed ?
I do not think we should forbid this. Any documentation is much better
than no documentation.
> They do link the documentation to the package listing/description. In
> such a case, it might be kind of confusing to keep
> 2 different documentation synchronized.
We might add links in the manual pointing to the external
documentation. This way people, who are looking for package
documentation in the manual, will relatively easily be able to find the
external documentation as well.
> Just a proposal: We could have a set of XML template documents with a
> clear how-to for
> developers. This might help if the developers are serious on writing
> some good documentation.
That would be fine.
--
- Martin Martin Jansen
http://martinjansen.com/