scientificdocumentationstandardsections（17页）.docVIP

NATIONAL WEATHER SERVICE OFFICE of HYDROLOGIC DEVELOPMENT SCIENTIFIC ALGORITHM DOCUMENTATION STANDARD Prepared by: National Oceanic and Atmospheric Administration National Weather Service Office of Hydrologic Development 1325 East West Highway Silver Spring, MD 20910  Table of Contents Purpose of this Document 1 1 . Document History 2 2 . Introduction 2 2.1 Executive Summary 2 2.2 Terminology 3 2.3 Background 3 2.4 Problem Statement 3 3 . Scientific Description 3 3.1 Methodology or Theory – (equations and computations) 3 3.2 Limitations 3 3.3 Future Work 4 4 . Use Cases 4 5 . Algorithm Description 5 5.1 System Dependencies and Limitations 5 5.2 Data Dictionary 6 5.3 Data Element Examples 6 5.4 Diagrams (DFDs, Logic Diagrams, State Diagrams, Control Hierarchy, etc.) 8 5.5 Other Applicable Standards 8 5.6 Interface requirements and references (e.g. ICDs) 8 5.7 Algorithm Description 9 5.7.1 Computations 9 5.7.2 Procedures (Pseudocode) 9 5.7.3 Pseudocode Constructs 10 5.7.3.1 Algorithm Construct 10 5.7.3.2 DO WHILE Construct 10 5.7.3.3 DO UNTIL Construct 10 5.7.3.4 IF-THEN-ELSE Construct 11 5.7.3.5 CASE Construct 11 5.7.3.6 Logical Constructs 12 5.7.3.7 I/O Constructs 12 5.7.3.8 COMPUTE and EXIT Constructs 13 6 . Outputs (format, real time, rate, etc.) 13 7 . References 14 Appendices 14 Appendix A – Acronym List 14 Appendix B – Glossary 15 Appendix C – Data Elements List, Alphabetical Order 15 Appendix D – Data Elements List, Subroutine Order 15 Purpose of this Document This document contains guidelines for writing scientific documentation of algorithms for everyone working in the Hydrology Laboratory (HL). Its purpose is to describe a standard method for articulating scientific algorithms in such a way as to be understood by all interested parties. All scientific algorithms documented after the approval date of this Scientific Documentation Standard, whether documenting new algorithms or existing prototypes or pieces of software,