ZF Blog

Help us improve the documentation!

A piece of software is only as good as its documentation. The Zend Framework team and a dozen or so contributors are working hard to improve the Zend Framework 2 documentation, but we still want you to help us improve it even more. Any kind of help is welcome and greatly appreciated.

First of all, you don't have to have a major in English literature to help us with the documentation. We, the contributors, come from all over the world and many of us use English as a second — or even third! — language, but that does not stop us from trying to improve the docs. Neither should it stop you.

We are not asking for much. Read a chapter or two, or even just a paragraph. Point us to parts of the documentation that are confusing, unclear, or not explained well enough. Would it be easier for you to understand a section if we would add a picture or two? Tell us. Do you want to see more code examples? Let us know. Pick a component that you use most often and work with the contributors to have the documentation for that component as clear as possible. Have something to add? Send a pull request.

We all learn in different ways, and while some documentation might be good for one developer, it might be confusing for another. That's why we are striving to have several different ways of presenting the material: reference manual, tutorials, user guides, API docs. Let us know what works best for you and we will do our best to make it happen.

We would like to ask you one thing, though. Any and all problems, requests, ideas you have that can help us improve the documentation, please report them on the documentation issue tracker on Github. Thanks!

If you'd like to start contributing to the documentation by submitting patches and improvements, the best place to start is to read the contributing guide.

Just so you know that we do really work on improving the documentation, a week or so ago we held our first dochunt. It was a weekend dedicated to improving the documentation and as you can see from the results quite a few fixes and improvements were made, thanks to those who participated. In the coming weeks, we will hold the next dochunt. This time we will try to strictly focus on writing new tutorial and improving existing ones, but any and all contributions are welcomed.

We don't know yet when the second dochunt will be held, but we will let you know. Until then, start reading through the manual, look for things to improve, keep a list of what's missing, and give us feedback!

The contributors and the Zend Framework team thank you!

Return to entries

blog comments powered by Disqus