Home -> Toolkit -> Docs -> Development

Map of the documentation planned for the Common Runtime Components in GT4

Draft: 24 September 2004

Release-related docs for GT Common Runtime Components

• Release manuals
• Other docs related to the Common Runtime Components in support of the release
• Atomic fragments of Common Runtime Component-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

Common Runtime Component Release Manuals	Purpose	C WS Core	Java WS Core	C Common Libraries	XIO
Component Key Concepts Manual [draft template]	Stable release documentation page that describes fundamental concepts of the components	no draft available
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	N/A	Current draft
Component Sysadmin Guide [draft template]	Stable release documentation page that describes how to install, deploy and maintain a given component	Current draft	Current draft	N/A	Current draft
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	N/A	Current draft

Miscellaneous Common Runtime Component Docs

Other docs related to the Common Runtine Components in support of the release	Purpose	C WS Core	Java WS Core	C Common Libraries	XIO
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	Current draft	Current draft
GT4 Component Fact Sheet [template]	Provides useful implementation details about a component in advance of the next stable release	Current draft	Current draft	Current draft	Current draft
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	N/A	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	N/A	no draft available	N/A	N/A
Beta Release Testing Call [draft template not yet available]	Identifies key aspects of a GT development release that warrant wide testing	N/A	no draft available	N/A	N/A
Alpha Release Testing Call [template]	Identifies key aspects of a GT development release that warrant wide testing	N/A	Current draft	N/A	N/A
Component Public Interface Overview [template]	Identifies the public interfaces for the component	Current draft	Current draft	Current draft	Current draft

Reusable Fragments of Common Runtime Component Content

Atomic fragments of Common Runtime Component content for reuse in multiple docs	Purpose	C WS Core	Java WS Core	C Common Libraries	XIO
Brief Component Overview Text Fragment [template]	Single paragraph that provides an overview of the component for reuse across multiple docs	Current draft	Current draft	Current draft	Current draft
Component Feature Summary Fragment [template]	Provides an overview of the features of the component for reuse across multiple docs	Current draft	Current draft	Current draft	Current draft
Tested Platforms Fragment [template]	Reusable fragment that summarizes the platforms on which the component has been tested	Current draft	Current draft	Current draft	Current draft
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	no draft available
Component Backward Compatibility Summary Fragment [template] [bugzilla url here]	Reusable fragment that summarizes changes to the public interface in this release	Current draft	Current draft	Current draft	Current draft
Component Dependencies Summary Fragment [template] [bugzilla url here]	Reusable fragment that summarizes technology dependencies for the component	Current draft	Current draft	Current draft	Current draft
Component Interface API Fragment [template]	Reusable fragment that identifies the APIs of the component	Current draft	Current draft	Current draft	Current draft
Component Interface WSDL Fragment [template]	Reusable fragment that documents the WSDL associated the component	Current draft	Current draft	Current draft	Current draft
Component Interface Command-Line Tool Fragment [template]	Reusable fragment that describes the command-line tools for the component	Current draft	Current draft	Current draft	Current draft
Component Configuration Interface Fragment [template]	Reusable fragment that identifies the configuration options for the component	Current draft	Current draft	Current draft	Current draft
Domain-Specific Interface Description Fragment [template]	Reusable fragment that identifies the domain-specific interface data of the component	Current draft	Current draft	Current draft	Current draft
Component Interface to Environement Variables Fragment [template]	Reusable fragment that identifies the interface to environment variables by the component	Current draft	Current draft	Current draft	Current draft
Component GUI Description Fragment [template]	Reusable fragment that identifies the GUIs of the component	Current draft	Current draft	Current draft	Current draft