WebAppsDocPlan
Documentation Plan for NetBeans 6.0: Web Applications Documentation Plan
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 online Help and tutorials that are planned for the FCS releases of NB 6.0.
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 for web Applications (including Visual Web). 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.
Important Links
Documentation Deliverables
Online Help
Writers: James Branam (lead), Paul Fussell
For this release, two writers will deliver the documentation listed in the following table.
| Feature | Assignment | Time Estimate | Status | Engineering Contact | QE Contact | Comments |
|---|---|---|---|---|---|---|
| Transfer Web Apps topics to Visual Web | James | Completed | None | None | ||
| Create a common index for Visual Web and Web Apps | James | Completed | None | None | Index is no longer visible | |
| Create a common TOC | James | Completed | None | None | ||
| Initial deletion of redundant topcis | James and Paul | Completed | None | None | ||
| Helpset creation and basic functionality | James and Paul | Quy Nguyen | ||||
| VW Projects | Paul | |||||
| Update links | Paul and James | In progress | ||||
| AppServer topics | James | |||||
| Database topics | James | In progress | Some topics to be deleted | |||
| Components topics | Paul | In progress | ||||
| Visual Designer topics | Paul | Major changes | ||||
| Update VW icons | Paul and James | |||||
| Palette topics | Paul | |||||
| Databinding topics | James | In progress | Jim Davidson | |||
| Web services | James | |||||
| EJBs | James | |||||
| CSS Editor | James | |||||
| JSF | Paul | |||||
| Query Editor | James | |||||
| Page Navigation | Paul | |||||
| Options window | Paul | |||||
| A11Y | James | In progress | Will try to link to NB topics | |||
| General Web Topics | James | In progress | ||||
| Build Web Apps | James | |||||
| Deploy Web Apps | James | In progress | ||||
| Debug Web Apps | James | |||||
| Web Apps images | James | |||||
| Creating Web Apps | James | In progress | ||||
| Feedback ? | Paul | |||||
| Tutorial links? | Paul | |||||
Tutorials
Writers: Joe Silber (lead), and Cindy Church
For this release, at least one writer will deliver the documentation listed in the following table.
Put tutorials table here.
Docs Priorities
- Online Help and tutorials that highlight new 6.0 features
- Updates of existing tutorials for 6.0 interface changes and capabilities
