NOAA/NESDIS Banner
Satellite Products and Services Review Board

 
OSD Banner with images related  to OSD organization.
  cloud image
Navigation Menu
 SPSRB
   - Home
   - Process Paper
   - Performance Metrics
   - Oversight Panels
   - SPEEDS Capabilities
 Meetings
   - Schedule
   - Briefing Templates
   - Meeting Material
   - Minutes & Action Items
 Requests
   - User Request Submission Form
   - Archived Requests
 Policies and Guidance
   - Annual Reviews
   - Project Reviews
   - Archive Guidance
 Standards
   - Overview
   - Standards/Best Practices
   - Documentation & Data
     Management
   - Systems
   - Software & Coding
   - Announcements
 

SPSRB Documentation & Data Management Standards


The SPSRB has acknowledged the importance of common and sustainable documentation with the given files. A new template for each of the standard documents is set forth herein that will help guide developers, operations and users with SPSRB products. It is given as a set of 4 major guidelines and coordinating templates to aid in the creation and implementation of products. Formatted to work within the context of content management software, the new standard employs the concept of Document Objects, small sections that can be edited independently and come together to form a whole document. The CSWG is working to provide stakeholders with approved content management software.

All new projects and those undergoing significant revision should employ these new standards for their documentation. Heritage products may retain their previous documentation in the old format and people can refer to the retired template and examples mentioned after the table.


Documentation & Data Management Standards
Status
End of Review Period
Documentation Standard Guidelines
Approved
Review Complete
Documentation Standard Templates
Approved
Review Complete


The old version of the Documentation Standards Template has been retired by the SPSRB but is still available for reference.


Questions or Comments: Please email Zhaohui Cheng or Priyanka Roy




NOAA Homepage Satellite Products and Services Review Board