Re: wiki structuring

From: Date: Fri, 21 Jan 2005 16:42:25 +0000
Subject: Re: wiki structuring
References: 1 2 3 4  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-5458@lists.php.net to get a copy of this message
Lukas Smith wrote:
One of the points point of the wiki is that it is more free-form than the highly-structured DocBook; whatever happens on the wiki may or may not be translated into the formal DocBook documentation. I think of the wiki not as the pre-DocBook version, but as its own parallel thing. If we can evenutally use it as a source for DocBook, great, but I believe its best purpose will be found by the end-users, not by PEAR Group or PEAR QA top-down dictate.
I disagree. I think its all cool for people to write examples in their chosen format. But for API documentation a standard is a requirement. Even if it will never be exported to docbook.
Agree that API docs should adhere to a standard. Lucky for us, that standard is already defined, in place, and operational: API docs are automatically generated by PhpDocumentor for all packages. I see the wiki more as example, tutorial, explanation, narrative, prose ... not as an API documentation source. -- pmj

« previous php.pear.doc (#5458) next »