From TeraGrid Wiki
Status: This document lays out formatting and minimum information requirements for TeraGrid policy documents.
Author: Charlie Catlett
Date: February 6, 2006
Revised: March 7, 2006
In order to readily determine the status of draft, proposed, or final policies it is necessary to have clarity with respect to status, policy, authorship and dates. This document lays out required formats and minimum information requirements for TeraGrid document drafts submitted for consideration as TeraGrid policies or informational documents.
Information Requirements for First and Subsequent Pages
Requirements for First Page
The first page of the document must contain the following information (see an existing draft for format suggestions):
<document type> (see below)
<author or editor>
<original draft date>
[current revision date]
[name of working group or RAT]
Where document type is one of the following:
- Draft: a policy that is submitted but has not yet been approved as proposed policy.
- Proposed: a policy proposal that has been reviewed by the TeraGrid GIG and is in discussion with TeraGrid stakeholders.
- Policy: a policy that has been adopted as official TeraGrid policy
- Informational: a document that provides important information but does not outline a policy.
Requirements for Subsequent Pages
All pages must have primary author (or editor) email address (where primary means the author who is designated as primary point of contact for comments) in lower left and page number in lower right.
All pages after the first page must have <document type> in the upper left and the current draft revised date in the upper right.
Numbering: Sections must be outline numbered (1, 1.1, 1.1.1, etc.). Note that the downloadable version of this document contains all necessary formatting for MSWord and thus may be used as a template.
Status, Abstract, Table of Contents
The document must begin (page 1) with a status statement, and a 1-2 paragraph abstract followed by a table of contents. Status must indicate the origin of the proposed policy, status of discussions (e.g. being circulated for discussion), and any key dates. Upon finalization of the policy the status section will include relevant dates such as effective date of the policy, any exceptions, etc.
The document must include a section commenting on any security implications of the policy.
This section notes the impact of the policy (implementation as well as ongoing) in terms of staffing effort, funding, or other resources
This section notes expected scaling issues, for example how the proposed work would impact additional resources or sites joining TeraGrid.
The following acknowledgement, citing both the GIG and (if applicable) any RP awards, should be included in any TeraGrid policy document. Other awards, agencies, or sources of support relevant to the policy development work should also be cited.
“This work was supported by the National Science Foundation Office of Cyberinfrastructure, grant number 0503697 “ETF Grid Infrastructure Group: Providing System Management and Integration for the TeraGrid.”
Author or Editor Contact Information
The document must include a section with author contact information including name, affiliation, and email address.
A glossary is highly recommended, particularly where many acronyms are used.
This document has no impact on security, as it only addresses document formats for policies.
This document has no impact on resources.
This document helps to streamline policy decisions, thus has a positive impact on scaling.
This work was supported by the National Science Foundation Office of Cyberinfrastructure, grant number 0503697 “ETF Grid Infrastructure Group: Providing System Management and Integration for the TeraGrid.”
Charlie Catlett, University of Chicago / Argonne National Laboratory