JBI Integration With AS9.1 Documentation Plan

• JBI Integration Overview
• JBI Integration and AppServer Profiles
• JBI Writers
• JBI Related AppServer Documentation Deliverables
• Summary of Documentation Changes by Feature
• Schedule
• Release Exit Criteria

JBI Integration Overview

• Admin Guide will add conceptual information needed to understand the JBI integration in the AppServer.
• Admin Console will document the JBI node screens and standalone-instance JBI tab (inline and Online help).
• Developer's Guide will add JBI integration info (JSR 208) from a developer's perspective.
• Reference manual will be updated with the new JBI asadmin commands.
• Installation Guide updated as necessary to include any JBI related screens (covers install of AppServer NOT glassfish).
• QuickStart guide will be updated with any JBI setup as necessary (not required for Milestone 2)
• Troubleshooting guides will be updated with JBI troubleshooting tips.
• Error message online wiki catalog will add any JBI related error messages.
• Release notes will include any JBI known issues.

All AppServer documents will reference the Open ESB opensource website and the Open ESB documentation.

JBI Integration and AppServer Profiles

In this release, AppServer Editions are replaced with Profiles. As a result of this change, content that applies only to a particular profile will carry a statement to that effect. Only one version of the bundled docs (e.g. OLH page), will be produced.

JBI Writers

• Alan Sommerer (SCA) - Manager
• Paul Davies (SCA) - Lead writer
• Hanan Lang (SCA) - Admin Guide topics, online help topics
• Scott Fordin (BUR) - Release Notes, Troubleshooting Guide, Error Message Reference
• Chinmayee Srivathsa (BLR) - Admin Guide topics, asadmin manpages, admin console online help
• June Parks (SCA) - works Weds-Fri Developer's Guide
• Rajeev Jayarajan (BLR) - JBI topics in Admin Guide, online help, and manpages.

JBI Related AppServer Documentation Deliverables

The following table lists the JBI related Appserver document deliverables. Author assignments are tentative.

Summary of Documentation Changes by Feature

Feature	Affected Documentation	Responsible Writers
Administration
AdminConsole GUI	Admin Guide JBI topics	Rajeev
	Admin GUI online help, including help for JBI	Rajeev
	Admin GUI inline help for JBI screens	Scott Fordin
	JBI command man pages	Rajeev
Management API (AMX)	No impact	N/A
Integration
JBI Integration	Administration Guide	Rajeev
	Developer's Guide	June
	CLI man pages	Chinmayee, Rajeev, Vipin
	Open ESB documentation	Gavotte documentation team

Schedule

Based on schedule in AS9.1 Plan Proposal. For more detailed doc schedule information, see the AS9.1 Schedule.

In the following schedule, all times are C.O.B., PST, unless otherwise noted. See the preceding table to see which docs are bundled and which are posted to docs.sun.com. Although bundled, the About page has separate line items in the schedule. The tasks in parentheses require no action by tech pubs but do affect our schedule.

Localization

The following documents will be localized for AS9.1:

• Release Notes
• Online Help

Release Exit Criteria for Docs

• Monthly glassfish wiki postings: pre-beta quality; snapshot of docs in their current state.
• Beta: Full doc set, beta quality, no unwaived P1 or P2 bugs. "Full doc set" means that no guides will be missing. "Beta quality" means that the scope of a document might be cut in order to meet the schedule deadlines. The tech writers will work with the engineers to determine which topics are the highest priority.
• RR: Full doc set, no unwaived P1, P2, or P3 bugs.

Accessiblity

Before FCS, we must verifiy accessibility of HTML files by running the following script:

/java/pubs/bin/check508 -t <fully-qualified-directory-name>

This page (revision-3) was last changed on 27-Feb-07 17:42 PM, -0800 by PaulDavies.
This page was created on 02-Feb-07 11:46 AM, -0800 by hanan.

More info...