Service Technical Reference Sheet

This document is a template for Service Technical Reference Sheets.  The indication "[M}" indicates a mandatory item.

In order to complete this for a specific application, please do the following:

1. Replace "<Service>" at the top of this page and its title with the name of the application.
2. Replace the date at the top of this page with the current date.
3. Replace the non-bolded text in this document, including this text, with the appropriate information.

Required at Start of Development

CVS Project and Release Tag [M]

The name of the CVS project and this release's tag.  (The tag is not mandatory until the first production release.)

Overview [M]

(Brief overview of the application.)

Project URL

If it exists, the URL of the development project's home page.

Names of Technical Contacts [M]

List the names of the people with technical knowledge of the application.  Indicate primary/secondary/etc. as appropriate.

Required at Start of Production

How This Service Is Accessed [M]

(e.g., URL, batch command, TCP port, etc.)

Architecture Overview [M]

("100 words or less."  Refer to internal documentation where appropriate to keep this section brief.  Topics covered should include a general process description, access control and authentication, recovery and failover, etc.)

Operations Overview [M]

• Service Status: ("7x24", "Development")
• Location of Startup, Shutdown, and Restart Procedures: ( e.g. , URL)
• Location of Monitoring Scripts: (e.g., URL)
• Downtime Policy: (e.g., "Downtime should be schedules between midnight and 6 AM with at least two days notice.")
• Backup Schedule: (e.g., "Daily TSM incrementals of all files in /xxx.")
• Location of Other Procedures: (e.g., URL)

Batch Production Overview [M]

("100 words or less."  List URLs of production procedures and their schedules; refer to a separate document, if appropriate.)

Resource Requirements [M]

• Disk Storage (Permanent and Temporary):  (e.g., "40 GB, plus 100 GB for weekly production processing.  2 GB is needed for development.")
• Files:  (List, with annotation, important configuration, log, etc. files.)
• Service and Database Dependencies:  (List other services and databases that are required by this application.)
• Development Environment:  (List compilers, libraries, etc. required to build this application.)
• Production Environment:  (List hardware, software, OS, etc. required to run this application.)

Other Documentation

(List references to any other documentation that is appropriate, but not covered in the other sections of this document.)