SOATutsDocPlan
Documentation Plan for NetBeans 6.0 Preview: Tutorials Documentation Plan (not module specific)
Bob May, Sherry Barkodar
This document is only a draft and will only be complete two weeks after engineering plan is approved and complete.
This document provides information about the tutorials that are planned for the FCS releases of NB 6.0. These tutorials are not specific to any one module in NetBeans since they cover functionality found in different modules in the pack. Deliverables specific to a module are covered separately.
For the overall documentation plan for the Beta and FCS releases of NB 6.0 FCS, see the NB6 Umbrella Doc Plan.
Contents |
Introduction
This plan describes the documentation deliverables that cover the entire product, not separate modules. The documentation objectives are to provide clear, concise, technically accurate, and easily accessible information about using NetBeans 6.0. If there are dependencies on other functional teams, such as Engineering, QA, Marketing and the component products documentation teams, those are also listed in this document.
Dependencies
- Features need to be complete enough to accurately document.
- UI stability is critical for step by step documentation accuracy.
- Quality of documentation can benefit considerably from QE and technical feedback.
- Stable separation of product features from CAPS product (i.e., IEP, SMPT)
- Coordination with Blueprints group
Documentation Deliverables
For this release, one writer and the tutorials architect will deliver the documentation listed in the following table that is not specific to any one module in NetBeans.
| *P* | *Title* | *Description* | *Tasks for 6.0 FCS* |
|---|---|---|---|
| 1 | Creating a Loan Processing Composite Application, | An overview of a simple Loan Requestor composite application and illustrates deploying, executing, and testing of a Composite Application using the NetBeans Enterprise Pack bundle with all the necessary runtimes.--6.0 Preview version URL: http://www.netbeans.org/kb/60/loanprocessing.html | Redesign Preview version to match product for Beta 1 |
| 1 | Understanding the Sample Loan Processing Composite Application | Explain the Loan Processing Composite Application sample project (to be included in IDE or as a downloadable file, depending on time constraints). Similar to Understanding the Travel Reservation Service. Note: This sample application may be used by the BluePrints team. | Blueprint team deliverable. Contacts TBD. |
| 1 | Developing a Hello World Composite Application | How to create a simple BPEL module project and a Composite Application project. How to design and deploy a BPEL process. How to create and perform a test run of a composite application.6.0 Preview version http://www.netbeans.org/kb/60/helloworldca.html | Update 6.0 Preview version to match product |
| 1 | Creating a Simple SOA Application With NetBeans Enterprise Pack | How to create a simple SOA project, using WSDL editor and CASA editor, use File BC in a composite application.6.0 Preview version http://www.netbeans.org/kb/60/ep-simple-soa-app.html | Update 6.0 Preview version to match product |
Docs Priorities
- Tutorials that highlight new 6.0 features
- Updates of existing tutorials for 6.0 interface changes and capabilities
Method of Delivery
NetBeans Portal-Integrated into netbeans cvs repository (for publication on www.netbeans.org).
Schedule
| Task/Delivery* | *Milestone* | *Date* | *Notes* |
|---|---|---|---|
| Feature Freeze | NA | 27 June 2007 | Plan posted for review/approval by approvers |
| Guide and Tutorials: deliverables posted for QE review | (20 Sept 2007) | Approvers sign off on the plan | |
| Guide and Tutorials: FCS deliverables posted to staging server | FCS Bits Go/NoGo | (1 Oct 2007) | At this stage, docs will be reviewed by QE and QE will provide feedback before next milestone in schedule (FCS Bits Go/NoGo). |
| Guide and Tutorials: Reviewers review/approve deliverables | FCS Bits Go/NoGo | (8 Oct 2007) | Reviewers have until FCS - 4 business days to review/approve content posted to staging server. |
| Guide and Tutorials: 100% ready for publication and pick up by G11N | L10N Docs Handoff | (15 Oct 2007) | This is a 100% complete delivery of docs for publication on netbeans.org |
The dependencies listed below affect the timely and successful delivery of Gavotte Documentation.
All dependencies and requirements must be fulfilled. Any unfulfilled dependencies will result in changes to this plan.
Specific dependencies for completion of the deliverables described in this plan include:
- Completed Functional Specifications are required for the tutorials architect and writers to get acquainted with any new functionality and prepare content for each documentation deliverable.
- Reliable Builds. The docs team relies on stable milestone builds that contain the promised functionality and are delivered on scheduled dates.
- Timely Reviews. Writers will contact individual reviewers to schedule focused reviews and notify reviewers of upcoming reviews. Reviewers will return comments in a timely fashion, based on the review schedule established in this doc plan.
- Documentation Testing (QE). All documentation must be thoroughly tested for usability and technical accuracy. To meet this requirement, QE resources must be available to test all documentation deliverables.
