WACT Documentation Philosophy

WACT combines inline API documentation with this Wiki to provide an experimental mix of static and organic information. Within the API documentation there are links to pages in the Wiki, a page already having been created for each major class and function within the library.

The purpose of keeping parts of the documentation in this wiki is to significantly lower the activation energy for users to be able to contribute to the documentation. One need only look at the open comments in the PHP documentation to see the power of collaborative documentation.

The documentation for PHP functions tends to be very complete with comments providing examples, clarification, and pitfalls. Yet, that medium does not allow subsequent contributors to clarify, edit or remove previous contributions. Thus, the comments tend to have a great deal of noise as well as gems. A Wiki is designed for this type of collaborative writing.

In many ways the documentation experiment has failed. As the code has been updated, the wiki has not. We never achieved the integration from phpDocumentor and the Wiki that would have allowed doc blocks to form the seed around which a wiki page could grow. – Jeff

Additional Information