Standard Guide for Documenting Computer Software for Fire Models

SCOPE
1.1 This guide provides information that should be in documentation for computer software prepared for scientific and engineering computations in fire models and other areas of fire protection engineering.
1.2 The guidelines are presented in terms of three types of documentation: (1) technical document; (2) user's manual; and (3) installation, maintenance, and programming manual.
1.3 This standard does not purport to address all of the safety concerns, if any, associated with its use. It is the responsibility of the user of this standard to establish appropriate safety and health practices and determine the applicability of regulatory limitations prior to use.

General Information

Status
Historical
Publication Date
30-Sep-2003
Technical Committee
Current Stage
Ref Project

Relations

Buy Standard

Guide
ASTM E1472-03 - Standard Guide for Documenting Computer Software for Fire Models
English language
5 pages
sale 15% off
Preview
sale 15% off
Preview

Standards Content (Sample)

NOTICE: This standard has either been superseded and replaced by a new version or withdrawn.
Contact ASTM International (www.astm.org) for the latest information
An American National Standard
Designation: E 1472 – 03
Standard Guide for
1
Documenting Computer Software for Fire Models
This standard is issued under the fixed designation E 1472; the number immediately following the designation indicates the year of
original adoption or, in the case of revision, the year of last revision. A number in parentheses indicates the year of last reapproval. A
superscript epsilon (e) indicates an editorial change since the last revision or reapproval.
4
1. Scope ANSI/INCITS X3.88 Computer Program Abstracts
2.4 IEEE Standards:
1.1 This guide provides information that should be in
ANSI/IEEE 610.12 Glossary of Software Engineering Ter-
documentation for computer software prepared for scientific
5
minology
and engineering computations in fire models and other areas of
5
ANSI/IEEE 1063 Software User Documentation
fire protection engineering.
1.2 The guidelines are presented in terms of three types of
3. Terminology
documentation: (1) technical document; (2) user’s manual; and
3.1 Definitions—Definitions used in this guide are in accor-
(3) installation, maintenance, and programming manual.
dance with Terminology E 176, unless otherwise indicated.
1.3 This standard does not purport to address all of the
ANSI/INCITS X3.172 and ANSI/IEEE 610.12 include defini-
safety concerns, if any, associated with its use. It is the
tions of some technical terms used in this guide.
responsibility of the user of this standard to establish appro-
priate safety and health practices and determine the applica-
4. Significance and Use
bility of regulatory limitations prior to use.
4.1 This guide provides recommendations for writers of
2. Referenced Documents user’s manuals and other documents for computer software
2 prepared for scientific and engineering computations in fire
2.1 ASTM Standards:
models and other areas of fire protection engineering. The
E 176 Terminology Relating to Fire Standards
guide provides information that can be included in terms of
E 1355 Guide for Evaluating the Predictive Capability of
three types of documents.
Deterministic Fire Models
4.2 This guide is intended to assist in the understanding,
E 1591 Guide for Obtaining Data for Deterministic Fire
usage, transfer, conversion, and modification of computer
Models
software. If the options and instructions contained in this guide
E 1895 Guide for Determining Uses and Limitations of
are considered when documentation is prepared, the software
Deterministic Fire Models
should be used more readily for its intended purposes.
2.2 ANS Standards:
4.3 The use of fire models currently extends beyond the fire
ANSI/ANS 10.2 Portability of Scientific and Engineering
3 research laboratory and into the engineering, fire service, and
Software
3 legal communities. Sufficient documentation of computer soft-
ANSI/ANS 10.3 Documentation of Computer Software
ware for fire models is necessary to ensure that users can judge
ANSI/ANS 10.5 Accomodating User Needs in Computer
3 the adequacy of the scientific and technical basis for the
Program Development
models, select the appropriate computer operating environ-
2.3 INCITS Standards:
ment, and use the software effectively within the specified
ANSI/INCITS X3.172 American National Standard Dictio-
4 limitations. Adequate documentation will help prevent the
nary for Information Systems
unintentional misuse of fire models.
4.4 Additional guidelines on documentation can be found in
ANSI/ANS 10.3 and ANSI/IEEE 1063.
1
This guide is under the jurisdiction of ASTM Committee E05 on Fire Standards
4.5 ANSI/ANS 10.2 and 10.5 provide guidelines for pro-
and is the direct responsibility of Subcommittee E05.33 on Fire Safety Engineering.
gramming to ease the portability of the software and meet user
Current edition approved Oct. 1, 2003. Published November 2003. Originally
approved in 1992. Last previous edition approved in 1998 as E 1472–92 (1998).
needs.
2
For referenced ASTM standards, visit the ASTM website, www.astm.org, or
contact ASTM Customer Service at service@astm.org. For Annual Book of ASTM
5. Types of Documents
Standards volume information, refer to the standard’s Document Summary page on
5.1 General:
the ASTM website.
3
Available from American Nuclear Society, 555 North Kensington Avenue,
LaGrange Park, IL 60526.
4
Available from InterNational Committee for Information Technology Stan-
5
dards, c/o Information Technology Industry Council, 1250 Eye Street NW, Suite Available from Institute of Electrical and Electronics Engineers Standards
200, Washington D.C. 20005. Association, P.O. Box 1331, 445 Hoes Lane, Piscataway, NJ 08855–1331.
Copyright © ASTM International, 100 Barr Harbor Drive, PO Box C700, West Conshohocken, PA 19428-2959, United States.
1

---------------------- Page: 1 ----------------------
E 1472 – 03
5.1.1 There are many levels of desirable documen
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.