Map of the execution management docs planned for GT4
Draft: 24 September 2004
Release-related docs for GT execution management components
- Release manuals
- Other execution management-related docs in support of the release
- Atomic fragments of execution management-related content for reuse in multiple docs
Please tell us what you think
If you wish to offer comments or suggestions regarding our documentation plans, please create a new bugzilla entry. Ideas for contributions are also welcome!
Release Manuals
| Execution Management Release Manuals | Purpose | Pre-WS GRAM | WS GRAM | WS Rendezvous |
|---|---|---|---|---|
| Component Key Concepts Manual [draft template] |
Stable release documentation page that describes fundamental concepts of the components | Conceptual Overview Architectural Overview |
||
| Component Developer's Guide [draft template] |
Stable release documentation page that describes how to use the programming interfaces of the component (e.g., APIs, service interfaces, etc.) | Current draft | Current draft | no draft available |
| Component Sysadmin Guide [draft template] |
Stable release documentation page that describes how to install, deploy and maintain a given component | Current draft | Current draft | no draft available |
| Component User's Guide [draft template] |
Stable release guide to component interfaces that support human-driven interactions, such as command-line tools, GUIs, etc. | Current draft | Current draft | no draft available |
Miscellaneous Execution Management Docs
| Other execution management-related docs in support of the release | Purpose | Pre-WS GRAM | WS GRAM | WS Rendezvous |
|---|---|---|---|---|
| Stable Component Release Notes [template] | Describes implementation details to existing and potential users of a component distributed as part of a new stable release | Current draft | Current draft | no draft available |
| GT4 Component Fact Sheet [template] | Provides useful implementation details about a component in advance of the next stable release | Current draft | Current draft | no draft available |
| Component Quality Profile [draft template not yet available] |
Presents current reports on test coverage, resource and memory leak analysis, bounds checking, and performance profiles | no draft available | no draft available | no draft available |
| Full-Featured Release Testing Call [draft template not yet available] |
Identifies key aspects of a GT development release that warrant wide testing | no draft available | no draft available | no draft available |
| Beta Release Testing Call [draft template not yet available] |
Identifies key aspects of a GT development release that warrant wide testing | no draft available | no draft available | no draft available |
| Alpha Release Testing Call [template] |
Identifies key aspects of a GT development release that warrant wide testing | no draft available | Current draft | no draft available |
| Component Public Interface Overview [template] |
Identifies the public interfaces for the component | Current draft | Current draft | no draft available |
Reusable Fragments of Execution Management Content
| Atomic fragments of execution management-related content (for reuse in multiple docs) | Purpose | Pre-WS GRAM | WS GRAM | WS Rendezvous |
|---|---|---|---|---|
| Brief Component Overview Text Fragment [template] |
Single paragraph that provides an overview of the component for reuse across multiple docs | Current draft | Current draft | no draft available |
| Component Feature Summary Fragment [template] |
Provides an overview of the features of the component for reuse across multiple docs | Current draft | Current draft | no draft available |
| Tested Platforms Fragment [template] |
Reusable fragment that summarizes the platforms on which the component has been tested | Current draft | Current draft | no draft available |
| Component Usability Improvement Summary Fragment [template] |
Reusable fragment that summarizes the usability improvements for this component | no draft available | no draft available | no draft available |
| Component Backward Compatibility Summary Fragment [template] |
Reusable fragment that summarizes changes to the public interface in this release | Current draft | Current draft | no draft available |
| Component Dependencies Summary Fragment [template] |
Reusable fragment that summarizes technology dependencies for the component | Current draft | Current draft | no draft available |
| Component Interface API Fragment [template] |
Reusable fragment that identifies the APIs of the component | Current draft | Current draft | no draft available |
| Component Interface WSDL Fragment [template] |
Reusable fragment that documents the WSDL associated the component | Current draft | Current draft | no draft available |
| Component Interface Command-Line Tool
Fragment [template] |
Reusable fragment that describes the command-line tools for the component | Current draft | Current draft | no draft available |
| Component Configuration Interface
Fragment [template] |
Reusable fragment that identifies the configuration options for the component | Current draft | Current draft | no draft available |
| Domain-Specific Interface Description
Fragment [template] |
Reusable fragment that identifies the domain-specific interface data of the component | Current draft | Current draft | no draft available |
| Component Interface to Environment
Variables Fragment [template] |
Reusable fragment that identifies the interface to environment variables by the component | Current draft | Current draft | no draft available |
| Component GUI Description Fragment [template] |
Reusable fragment that identifies the GUIs of the component | Current draft | Current draft | no draft available |