Monday, February 21, 2011

See Zend Framework 2 documentation proposal

See Zend Framework 2 documentation proposal submitted by Matthew Weier O'Phinney, that describes the drawbacks of old documentation system and provides some interesting thoughts on resolving mentioned issues.

The main point is to standardise the typical documentation section for each component like: Overivew, Quick Start, Configuration Options, Available Methods, Examples. This will indicate for components documentation authors which information should be presented in documentation and will make navigation and finding of required information more easier.

Feel free to participate in discussion.