Hi Dixie,
I agree with all your comments about the New Material and changes
Required for This Release section and the order of sections, so I'll
make those changes immediately.
I also agree with your comments about the Review Record section.
However, I'll wait until I hear from others before making any further
changes.
Regards,
-Paul
>
> I just looked at Paul's revision of the individual doc plan template.
> Couple of opinions:
>
> *1. Review Record section*
>
> All those colunms for dates seem to create a lot of distraction, and
> a lot of work (for me). I don't usually do such minute schedule mgmt.
> Plus, I don't think others could easily get what they need from the
> table, like Alex Pineda, QA mgr, or our boss.
>
> I don't know what I would put in the Features column for a chapter.
> June, can you give some examples? If you're talking about the work I
> need to do in that chapter, that leads me to my second comment.
>
> *2. New Material and changes Required for This Release section *
>
> How about we call this Statement of Work. Then, instead of listing
> features in separate tables, just have one table with the chapter
> on left and a column listing the work we have to do for that chpt.
> in a sort of checklist. Maybe a Comments column for notes?
>
> We could have a separate table for TP2, or just prepend those
> tasks with TP2-
>
> *Order of the sections.*
> I would personally put Related Information last. is there a reason
> it's first?
>
> Statement of Work should go before content outline because we have
> it earlier. Content outline will say Under Construction for a
> while.
>
> Truth is,we won't even have the breakdown of chapters
> until after task analyses. Do we list the chapters as they are
> are in the doc are now? Is best guess better than leaving it
> blank? If I have to map the TP2 features to the Admin Guide now,
> I'll have to use the current structure. Good reason for a
> separate statement of work table for TP2.
>
> Dixie
>
> Date: Fri, 08 Feb 2008 12:18:22 -0800
> From: Paul Davies <Paul-Martin.Davies_at_Sun.COM>
> Content-type: text/plain; format=flowed; charset=ISO-8859-1
> Subject: Document Plan Template Updated
>
> Hi,
>
> As requested in yesterday's meeting, I have updated the document plan
> template at
> http://wiki.glassfish.java.net/Wiki.jsp?page=GlassFishV3DocPlanAdminGuide .
>
> After looking at the example that June sent, I decided to modify this
> template only by adding the following columns to the Review Record Table:
>
> * New Features
> * Start for each milestone, namely, TP2, Beta, and Final
> * Due for each milestone, namely, TP2, Beta, and Final
>
> One feature of the Review Record that must be preserved: Each reviewer
> is listed in a separate *row* of the table. This feature enables us to
> hold reviewers accountable by recording when they reviewed each draft
> (or not). As this information was so frequently requested on earlier
> releases, I will ask you to maintain this table as you receive review
> feedback on the documents.
>
> I also left in the New Material and Changes Required for This Release
> section as I think that you should, if possible, list the changes that
> you plan to make and at least seek agreement on them before you start
> making the changes.
>
> As I mentioned yesterday, you will be free to remove sections from you
> document plans that do not apply to your document.
>
> Please review this version and let me know what you think. I would
> encourage you to open the page for editing to see if you'll be able to
> maintain the multicolumn Review Record table. One of the main weakness
> of the GlassFish wiki editor is the difficulty in editing wide tables.
>
> Regards,
>
--
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/