Taking Stock of Docs: What Worked and What Didn't?
By Gail Risdal on Dec 21, 2007
The end of the year is a good time to take stock: What worked, what didn't, what to focus on going forward.
The Application Server docs team tried some new things this past year and we'd like to know how you, our customers and documentation consumers, feel about them: What worked and what didn't?
A few items to consider:
- Documentation Comments Wiki – Do you know about it? Did you use it?
Was it helpful? The doc comments wiki is a great mechanism for providing feedback on the docs (and now we'd like feedback on the feedback mechanism!).
- User and Developer FAQs – Did you use or contribute
to either of these? Are they helpful? What would make them better?
These FAQs are definitely a community effort, so if you have something to
contribute, please do.
- Documentation Mailing List – Are you on it? If not, why
not join? If you're interested in documentation and in building
the documentation community, this is great place to get the conversation started. You can join the list from the GlassFish mailing lists page. The page isn't in alphabetical order so you'll need to scroll way down (the java.net infrastructure apparently orders the list based on age, oldest to newest).
- Documentation Planning Meetings – Now is the time to plan for Application Server 10 / GlassFish v3 and we need your input! We've been holding a series of informal planning meetings to which the community has been invited but so far it's been just us doc folks. Are you aware of these meetings? What's been stopping you from attending? What would make it more likely that you'd attend and get involved (different topics, different time, more advance notice, clearer understanding of what's being asked of you)? What would you like to see for docs? How should they be developed and delivered? So many questions! These planning meetings will start up again in January. Details can be found on the meetings page. Please join us!
That's just a sampling of what's been happening in the wonderful world of Application Server docs this past year (in addition to providing complete documentation sets for the Application Server 9.1 / GlassFish v2 and Application Server 9.1 Update 1 / GlassFish v2 UR1 releases!). So to ask the question again: What worked and what didn't? We'd love to hear your answer to that question and to the questions asked in the points above. Please leave a comment here or contact the doc team through the documentation mailing list. We'll be out for the holiday break but will respond to any and all comments when we get back, refreshed and rejuvenated. Thanks in advance, and happy holidays to anyone celebrating them right about now!