NB70DocPlan
NetBeans 7.0 Documentation Plan
Contents |
Introduction
This plan covers information deliverables for the NetBeans IDE 7.0 release that are created by the staff members of the NetBeans docs team.
If you want to provide your feedback or make your suggestion on a good topic to write about, contact NetBeans Docs team directly at
nbdocs_feedback at usersguide.netbeans.org
Approach
For the NetBeans 7.0 release, the focus for documentation falls into the following categories:
- Docs Support for 7.0 Release Themes
- Create new docs (or update existing ones) to demonstrate the use of new 7.0 features with the focus on the following primary and secondary topics:
- Support for Java EE 6, Glassfish v3.1, and Oracle WebLogic
- Oracle DB support
- JDK 7 support
- PHP (including development for Oracle DB)
- Web languages (JavaScript, HTML, CSS)
- Maven 3 integration
- Create new docs for areas to extend the current documentation or fill in the existing documentation gaps:
- Profiler, Debugger, Junit
- Java GUI Builder
- Update existing docs for other technologies to ensure they are valid for 7.0
- Create screencasts and demos to show the new features of the IDE or user workflow and provide practical instructions.
- New Content and Updates
- New content will be created for the priority areas listed above, plus critical existing docs will be updated to work with the 7.0 release.
- Help
- Context-sensitive topics for complex dialogs and wizards will receive the most attention.
Documentation Deliverables for 7.0
- See the NetBeans 7.0 Documentation Table for a complete list of existing tutorials and screencasts maintained by the staff writers of the NetBeans docs team.
- The table below lists only new documentation deliverables planned by the staff writers of the NetBeans docs team:
| Technology | Document | Format | Owner | Milestone | Notes | URL |
|---|---|---|---|---|---|---|
| Java EE, App Servers | Running a JSF 2.0 Web App on Oracle WebLogic Server | html | Ken | Beta 1 | Done | url |
| Java EE | Testing a JavaEE App using Embedded EJB Container - Ant | html | Ken | Beta 2 | TBD | |
| Java EE | Testing a JavaEE App using Embedded EJB Container - Maven | html | Ken | FCS | TBD | |
| Databases | Connecting to an Oracle DB | html | ken | Beta 1 | Done | url |
| Java Editor | JDK 7 Support in the NetBeans Java Editor | html | Alyona | Beta 1 | Done | url |
| Java Editor | Packaging and Distributing Java Desktop Applications | html | Alyona | Beta 2 | Done | url |
| Java Editor | Javadoc FAQ | wiki | Alyona | FCS | Done | url |
| GUI Builder | Designing a Basic Java Form Using the GridBag Customizer | html | Alyona | Beta 1 | Done | url |
| GUI Builder | Designing an Advanced Java Form Using the GridBag Customizer | html | Alyona | Beta 1 | Done | url |
| Version Control | Git User Guide | html | Alyona | Beta 2 | Done | url |
| Web Services, Java EE | Getting Started with EE6 RESTful Web Services | html | Jeff | FCS | Done. New DZone article otherwise just changes to existing Getting Started with RESTful WS tutorial | Dzone article |
| Databases, PHP | Adding OracleDB support to Creating a Database Driven Application With NetBeans IDE PHP Editor tutoral | html | Jeff | Beta 2 | Done | url |
| PHP | Generating PHP Doc with NetBeans IDE (video) – Beta 2 | video | Jeff | Beta 2 | Done | url |
| PHP | Improved PHP Refactoring and Word Wrap | video | Jeff | Beta 1 | done | url |
| PHP | Using PHP Code Templates | html | Jeff | M2 | Done | url |
| Web Languages | Editing HTML5 Documents in NetBeans IDE | video | Jeff | TBD | TBD | |
| Java EE, App Servers | Deploying a Web App to the Oracle WebLogic Server | video | Ken | 7.0 M1 | Done | url |
Doc Milestones
Doc milestones are set against the overall release milestones that are shown on the NetBeans 7.0 page
Note that the documentation delivery dates in this table will change if the milestones that they are tied to change.
| Milestone | Estimated Date | Actual Date | Notes |
|---|---|---|---|
| M2 Release | October 14, 2010 | October 14, 2010 | No actions from docs |
| Beta 1 Staging site ready | October 28, 2010 | October 21, 2010 | Tentatively, 2 weeks before Beta |
| Beta content review | November 11, 2010 | 4 days before Beta release | |
| Beta 1 Release | November 15, 2010 | Beta content published | |
| Beta 2 Content review | January 18, 2011 | Beta content staged | |
| Beta 2 release | February 15, 2011 | February 17, 2011 | Beta 2 content published |
| NetCAT Review start | February 17, 2011 | Call for review by NetCAT team | |
| UI Freeze | |||
| Online Help 100% complete | |||
| Code Freeze | |||
| RC1 | All docs are 80% complete, new docs 90% complete | ||
| FCS staging server ready | Staging FCS content | ||
| FCS content review | Tentatively 2 weeks before FCS | ||
| FCS content ready | Web content 100% ready | ||
| FCS | Sanity check after push; Docs kit delivered to L10n | ||
