GT4 Component Guide to Public Interfaces: [component name]

Draft: 14 October 2004
Target readers: Developers, Sysadmins, End-users

Semantics and syntax of [component name] APIs

Component interface API fragment template draft: 13 October 2004

Programming Model Overview

[Description of the programming model here]

Component API

[link to auto-genned API docs here]

Semantics and syntax of the WSDL for [component name]

Component interface WSDL fragment template draft: 14 October 2004

Protocol overview

[provide an overview of the protocol for the service]

Operations

[list and briefly describe each operation]

Resource properties

[list and briefly describe each resource property]

Faults

[list and briefly describe each fault]

WSDL and Schema Definition

[link to the source files here]

Command-line tool [tool name] for [component name]

Component interface command-line tool fragment template draft: 13 October 2004

Click here to see a nice example of content describing a command-line tool
If there is more than one command-line tool, put bullets up top and copy these topics for each tool

Command-line tool: [tool name] for [component name]

Tool description

[Description of the command-line tool here. ]

Command syntax

[list and describe command-line args here]

Limitations

[describe limitations of the tool here]

Overview of Graphical User Interface [gui name] for [component name]

Component GUI description fragment template draft: 14 October 2004

Overview of the purpose and functionality of the GUI

[say it here]

Command and options

[describe syntax for invoking the gui here]

Limitations

[describe limitations here]

Semantics and syntax of domain-specific interface for [component name]

Description for domain-specific structured interface data fragment template draft: 14 October 2004

Interface introduction

[provide an overview of the purpose and structure of the domain-specific interface]

Syntax of the interface

[list and describe detailed information here]

Configuration interface for [component name]

Component configuration interface fragment template draft: 14 October 2004

Configuration overview

[high-level characterization of the configuration options for the component here]

Syntax of the interface

[list and describe detailed config info here]

Environment variable interface for [component name]

Component interface with environment variables fragment template draft: 14 October 2004

  • provide details on settings and effect of env var #1
  • ...
  • provide details on settings and effect of env var #n