March 4th, 2010 by Lincoln Baxter III

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.

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.
I’m sure there is more, but that’s what I have at the top of my head.

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!
Lincoln Baxter, III

About the author:

Lincoln Baxter, III is the Chief Editor of Red Hat Developers, and has worked extensively on JBoss open-source projects; most notably as creator & project lead of JBoss Forge, author of Errai UI, and Project Lead of JBoss Windup. This content represents his personal opinions, not those of his employer.

He is a founder of OCPsoft, the author of PrettyFaces and Rewrite, the leading URL-rewriting extensions for Servlet, Java EE, and Java web frameworks; he is also the author of PrettyTime, social-style date and timestamp formatting for Java. When he is not swimming, running, or playing competitive Magic: The Gathering, Lincoln is focused on promoting open-source software and making technology more accessible for everyone.

Posted in OpenSource

2 Comments

  1. Dominik says:

    Modularize JBOSS Seam and provide Maven poms for the various parts.

    E.g. I really want to use JBoss Seams Mail component with JSF2/JavaEE6 (glassfish) but don’t want to go for the whole framework just because of this.

Leave a Comment




Please note: In order to submit code or special characters, wrap it in

[code lang="xml"][/code]
(for your language) - or your tags will be eaten.

Please note: Comment moderation is enabled and may delay your comment from appearing. There is no need to resubmit your comment.