GlassFish Server Open Source Edition 3.1 Documentation Plan

Related Information

Feature Documentation Plans

• Administration Console Documentation Plan
• Application Client Container Documentation Plan
• Cluster Infrastructure Documentation Plan
• Connectors (JavaEE Connector Architecture, Connection Pooling, JDBC-RA) Documentation Plan
• Deployment Documentation Plan
• Eclipse Integration Documentation Plan
• Embedded Server Documentation Plan
• Enterprise JavaBeans Documentation Plan
• File Layout Documentation Plan
• GMS Runtime Clustering and GMS Configuration Documentation Plan
• IIOP Failover and Load Balancing Documentation Plan
• In-Memory Session Replication Documentation Plan
• Installer Documentation Plan
• Java Persistence Documentation Plan
• JMS Integration Documentation Plan
• JMX/AMX API Documentation Plan
• Load Balancer Documentation Plan
• Logging Documentation Plan
• NetBeans Integration Documentation Plan
• OSGi Documentation Plan
• Packaging Documentation Plan
• RESTful API Documentation Plan
• Security Documentation Plan
• SSH Provisioning Documentation Plan
• Transaction Service Documentation Plan
• Upgrade Documentation Plan
• Web Tier Documentation Plan

Documentation Information

• Documentation Reviews
• Audience Analysis
• Style Sheet
• Documentation Quality Assurance
• Oracle GlassFish Server 3.0.1 documentation
• Sun GlassFish Enterprise Server v2.1.1 documentation

Engineering Information

• One-Pagers and Functional Specifications
• Summary of Requirements
• Overall Plan

Technical Writing Staff

Summary of Deliverables

GlassFish Server Books

GlassFish Server books are distributed through the web.

For the 3.1 release, the books that are to be provided are listed in the following table.

The full title of each book is as follows:

GlassFish Server Open Source Edition 3.1 abbreviated-title

abbreviated-title is the abbreviated title as listed in the table.

Example book titles:

• GlassFish Server Open Source Edition 3.1 Release Notes
• GlassFish Server Open Source Edition 3.1 Deployment Guide
• GlassFish Server Open Source Edition 3.1 Add-On Component Development Guide

Message Queue Books

Message Queue books are distributed through the web.

For the 3.1 release, the Message Queue books that are to be provided are listed in the following table.

Online Help Sets

Man Pages

Paul is responsible for delivery of man pages into Application Server builds. Owners of individual man pages are listed in the GlassFish 3.1 Man Page Document Plan.

Inline Help and System Texts

Bundled HTML Pages

1. Generated from the book.

Documentation Change Requests

Schedule

Bundled documentation consists of documentation that is bundled with the product, namely:

• Online help
• Inline help and system texts
• Man pages
• Bundled HTML pages

Unbundled documentation consists of the books, which are published on the web separately from the product.

Deliverables That Are to Be Translated

• Online help sets for the Administration Console
• asadmin CLI help
• Inline help and system texts

Documentation Exit Criteria

• All planned documentation deliverables present and complete ¹ .
• No unwaived P1, P2, or P3 bugs.

1. The scope of a document deliverable might be cut to meet the schedule. The technical writers will work with the engineers to determine which topics are the highest priority.