docs@glassfish.java.net

UPDATED: 1-pager list and feature documentation plan template

From: Paul Davies <Paul-Martin.Davies_at_Sun.COM>
Date: Wed, 17 Dec 2008 14:43:19 -0800

Hi,

I have updated the 1-pager list
<http://wiki.glassfish.java.net/Wiki.jsp?page=V3FunctionalSpecs> and the
feature document plan template
<http://wiki.glassfish.java.net/Wiki.jsp?page=GlassFishV3FeatureDocPlanTemplate>
to reflect the decisions and discussions of today's meeting.

*Next steps for documentation owners:

*If you are listed as as the documentation owner for a 1-pager or
functional spec, here's what you should do next:

    * When the 1-pager or functional spec becomes available, read it in
      preparation for conducting the user task analysis and writing the
      feature documentation plan.
    * Work with the relevant subject matter experts to schedule task
      brainstorming sessions as required.
      The subject matter experts are the authors of the 1-pager or
      functional spec, the reviewers, and the testing owner as listed in
      the 1-pager list.

After you have conducted the task brainstorming sessions:

    * Write up the results as a user task analysis.
    * Write the feature documentation plan on the basis of your user
      task analysis and the information that you have gleaned from the
      1-pager or functional spec.
    * When you have a reasonably complete draft of the feature
      documentation plan, submit it to your subject matter experts and
      the documentation community for review.

*Note - *If you discover as you begin reading a 1-pager or functional
spec that the feature is not a good match for your background and
experience, please let me know so that I can reassign the feature if
necessary.

Please let me know if you have any questions.

-- 
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/