UMLDocPlan
Documentation Plan for NB 6.0 UML Module - ** DRAFT **
Contents |
Introduction
This page describes the documentation deliverables for the Beta and FCS releases of the NetBeans 6.0 UML module. It is a subset of the NetBeans 6.0 Umbrella Doc Plan, which contains more information. Developer information about the UML module can be found here.
The following lists the feature changes in the NetBeans 6.0 UML module :
- code synchronization
- customizable code generation
- domain modeling code generation
- changes in the UML options dialog
Docs work for Beta 1 will focus on updating the online help to document the above feature changes. Work on updating at least 2 of the existing tutorials will begin once the online help has been updated for the Beta 1 release. Work on the other existing tutorials affected by the above feature changes will be done in the subsequent Beta and FCS releases.
The documentation objectives are to provide clear, concise, technically accurate, and easily accessible information about using the UML available in the IDE. If there are dependencies on other functional teams, such as Engineering, QE, Marketing and the component products documentation teams, those are also listed in this document.
Tutorials
The following lists the tutorials that will be updated or created for NetBeans 6.0, depending on resource availability. All tutorials will be delivered in HTML format and posted on http://www.netbeans.org.
| Name | Priority | Owner | Target Publish Date | Preliminary Word Count | Status | Comments |
|---|---|---|---|---|---|---|
| Existing Tutorials | ||||||
| Developing Applications | 1 | UML docs | Beta 1 | tbd | demo videos need to be redone; 5.5 translation exists | |
| Reverse Engineering Java Applications | 1 | UML docs | Beta 1 | tbd | demo videos needs to be redone; 5.5 translation exists | |
| Creating Use Case Diagrams | 2 | UML docs | Beta 2 | tbd | Mod. changes, 5.5 translation exists | |
| Creating Class Diagrams | 2 | UML docs | Beta 2 | tbd | Mod. changes, 5.5 translation exists | |
| Creating Collaboration Diagrams | 2 | UML docs | FCS | tbd | Mod. changes, 5.5 translation exists | |
| Creating Sequence Diagrams | 2 | UML docs | FCS | tbd | Mod. changes, 5.5 translation exists | |
| Creating Activity Diagrams | 2 | UML docs | FCS | tbd | Mod. changes, 5.5 translation exists | |
| New Tutorials | ||||||
| Roundtrip Engineering - Using forward and reverse engineering between model and source | 1 | UML docs and dev. teams | Beta 2 | tbd | New | |
| Creating Component Diagrams | 2 | UML docs | TBD(post-FCS?) | tbd | New | |
| Creating State Diagrams | 2 | UML docs | TBD(post-FCS?) | tbd | New | |
| Requirements Traceability to UML Modeling Elements | 3 | UML docs | TBD(post-FCS?) | tbd | New | |
Online Help
The online help for the UML module will reflect feature and UI changes that are delivered by "UI freeze date" which is on ??? . For the FCS release, the UML module will have a complete online help based on UI features frozen on specified feature/UI freeze date. This is dependent on the availability of a reliable build to use. The following lists the changes needed in the online help:
- New/updated help pages discussing Source Code Synchronization/merging
- New help page(s) for the Customizable Code Generation feature
- New help page(s) for domain modeling code generation, including the new Domain Templates pane in the Options window
- Update help pages for the redesigned UML Options window
- New help pages on align and distribute tools
- Update help page(s) for new submenu on creating UML file and project
- Update help pages(s) with any changes resulting from bug fixes
Technical Articles
The existing technical article will need to be updated to reflect the NB 6.0 version of the tutorials linked from the article. Any new tutorials will also need to be added in the article.. The proposed articles will need to be discussed further with the development team and scheduled for resources.
| Name | Priority | Owner | Target Publish Date | Preliminary Word Count | Status | Comments |
|---|---|---|---|---|---|---|
| Existing Articles | ||||||
| Why Model in UML? | 2 | UML docs | FCS | tbd | published in NB 5.5 only | need initial translation; create a NB 6.0 version with pointers to NB 6.0 UML tuts; update with any new UML tuts |
| Proposed Articles | ||||||
| Customizable Code Generation | 3 | UML dev team/docs assisting | TBD(post-FCS?) | TBD | new | wiki page on topic exists |
| Domain Modeling Code Generation | 3 | UML dev team/docs assisting | TBD (post-FCS?) | TBD | new | wiki page on topic exists |
Release Notes
UML Release Notes information will be included in the umbrella NetBeans 6.0 Release Notes for Beta and FCS releases. The specific UML section in the NB 6.0 release notes will be linked from the main UML docs index page.
QE and Dev teams need to provide the Docs team the relevant UML information that will need to be included in the Release Notes at least one week prior to NB 6.0 web docs being available in the staging server for each scheduled release (specify dates. The release note items must be provided in a timely manner to allow for proper documentation and review cycle. The Docs team will compile the items, send the Release Notes for review, and post the page in the staging server once approval has been received.
Installation Instructions
UML module is available via the NB 6.0 Full Installation mode and installation instructions will be included in the umbrella NetBeans 6.0 Installation document.
Method of Delivery
| Title | Delivery Mechanism | Format |
|---|---|---|
| Tutorials | Portal; Integrated into netbeans cvs repository (for publication on www.netbeans.org) | HTML |
| Online Help | IDE; Integrated into uml project in netbeans cvs repository | JavaHelp |
| Technical Articles | Portal; integrated into www cvs repository | HTML |
| Release Notes | Portal; Integrated into www cvs repository (in main NB 6.0 release notes) | HTML |
Schedule and Milestones
The schedule of UML documentation deliverables will follow the overall NB 6.0 documentation deliverable schedule, as outlined in the Milestones section of the NB 6.0 Umbrella doc plan.
Dependencies
The dependencies listed below affect the timely and successful delivery of UML 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. Required for the writer to get acquainted with any new functionality and prepare content updates for each documentation deliverable.
- Engineering Plans and Schedule. Required in order to develop detailed doc plan for the project. The schedule needs to identify dates for the milestones builds and address functionality that will be available in each build.
- 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.
- No additional demands on resources other than the tasks specified in this plan.
