Re: Services_Twitter documentation

Bill Shupp a écrit :

On Sep 10, 2009, at 11:47 PM, Christian Weiske wrote:

Hi all, We do again lack documentation so bad that Zend Developer Zone could publish a tutorial for Services_Twitter. People, especially the developers (shupp, izi, jstump), get on going! http://devzone.zend.com/article/4431-Using-the-Twitter-API-with-PHP-and-PEAR

Point taken. David, let's work on DocBook documentation on this one once we have the HTTP_OAuth stuff in order. This could be a pretty popular package. Cheers, Bill

Documentation is very important indeed, what about setting up a documentation plan and working on it in the next days ? I'm not sure it's a good idea to document each twitter API method, as it would duplicate the twitter API docs, but the plan could be something like: 1. Introduction/Quick start 2. Configuration This would deal with instantiation options, setting up a http proxy etc... 3. Authentication / Security 3.1 Basic Auth 3.2 OAuth 3.3 Using SSL 4. Making API calls This section would explain in details how to make API calls, how to deal with required and optional parameters and how to manipulate the returned results. 5. Exceptions This section would tell the user how to handle exceptions with Services_Twitter. 6. Examples Simple and advanced examples of what can be done with the package. -- David