Improving Community – The power of good, centralized documentation.
If you’ve ever programmed in PHP, Ruby, Perl, Groovy, and probably others, then you know how nice it is to have a central, official space for reference documentation and inline community feedback. This is something that has sorely been missing from the JEE community, and something that has caused many disparate websites to attempt putting forward a weak effort in providing useful documentation — you leave the community part aside to think that this is a good thing for any open-source technology.
Read the original post on in.relation.to
A successful open-source community documentation initiative has:
- Comprehensive documentation provided on a central, official website (http://seamframework.org)
- Inline comments and user feedback.
- The most common paths on the website are the most visible, intuitive paths.
- Fluent navigation and document hierarchies. (The URL matches the Breadcrumbs matches the content. If users get lost, users give up.)
- Accurate and relevant official information, well vetted information.
Making progress happen:In kick-starting my (hopefully long) tenure with Red Hat, I’m focusing on improving community documentation for the Seam Framework, and for Java EE as a whole. I’ve started by updated the Seam Framework website to more clearly display the links to Seam and Weld JIRAs; you previously had to do a little digging. All of my efforts can be tracked here: https://jira.jboss.org/jira/browse/JBSEAM-4585 Please, I ask if you find any outstanding problems, or points of pain with the Seam or Weld documentation, to add it to this Jira. If you can’t, then comment here and I’ll see that it’s addressed. SeamFramework.org needs work, and I do think that the community really belongs on jboss.org, in order to fully get credit for their hard work and great achievements. Jboss.org also provides much of the functionality that I’m looking for in a community management tool, but we’ll see what everyone wants 😉 Happy communities make happy software!
Posted in OpenSource