|
Thursday 17 September 2009 2:26:04 am
- comments all over the place are A Good thing (TM).
I think 50% of php's success is due to the online manual accepting comments. And if you look at it, a lot of code snippets are posted there, and nobody complains too loud, even though it is strictly speaking a manual and not a how-to guide.
On eZ side, most misdirected comments get a response redirecting the poster to the appropriate forum. If comments were disabled, some people would post on forums, ans some would just not post at all - we'd be loosing valuable information. - The issue tracker is your best friend. Yes, it could be improved, but with so many issues in it, the easiest way to find stuff is not trying to add extra categories and tree-based navigation, as much as having a good search engine. For every bug fixed, there are comments relating to the svn commit where it happened, and vice-versa. It just needs a bit of greasemonkey magic to turn those comments into links...
- official docs: it takes time to write and keep up to date good quality docs. The current material is split into "user manual" and "reference manual", which is kind of a standard way to document complex systems.
The complaint we hear most often is the lack of a "developer's manual", but of course sometimes people want a "newcomer / non-techie manual". I think the latter is a bit outside of the scope of what eZ Systems should provide, leaving it up to the community / 3rd parties. The good news is that there is currently renewed effort on the docs. - there is a new community site in the making, whose aim is to make it simple to gather and organize all of this information anyway
Principal Consultant International Business
Member of the Community Project Board
|
