ASTM E1472-03e1
(Guide)Standard Guide for Documenting Computer Software for Fire Models
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.
1.4 This fire standard cannot be used to provide quantitative measures.
General Information
Relations
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
e1
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.
1
e NOTE—The “no quantitative measurements” statement in 1.4 was added in October 2004.
1. Scope ANSI/ANS 10.5 Accomodating User Needs in Computer
3
Program Development
1.1 This guide provides information that should be in
2.3 INCITS Standards:
documentation for computer software prepared for scientific
ANSI/INCITS X3.172 American National Standard Dictio-
and engineering computations in fire models and other areas of
4
nary for Information Systems
fire protection engineering.
4
ANSI/INCITS X3.88 Computer Program Abstracts
1.2 The guidelines are presented in terms of three types of
2.4 IEEE Standards:
documentation: (1) technical document; (2) user’s manual; and
ANSI/IEEE 610.12 Glossary of Software Engineering Ter-
(3) installation, maintenance, and programming manual.
5
minology
1.3 This standard does not purport to address all of the
5
ANSI/IEEE 1063 Software User Documentation
safety concerns, if any, associated with its use. It is the
responsibility of the user of this standard to establish appro-
3. Terminology
priate safety and health practices and determine the applica-
3.1 Definitions—Definitions used in this guide are in accor-
bility of regulatory limitations prior to use.
dance with Terminology E 176, unless otherwise indicated.
1.4 This fire standard cannot be used to provide quantitative
ANSI/INCITS X3.172 and ANSI/IEEE 610.12 include defini-
measures.
tions of some technical terms used in this guide.
2. Referenced Documents
4. Significance and Use
2
2.1 ASTM Standards:
4.1 This guide provides recommendations for writers of
E 176 Terminology Relating to Fire Standards
user’s manuals and other documents for computer software
E 1355 Guide for Evaluating the Predictive Capability of
prepared for scientific and engineering computations in fire
Deterministic Fire Models
models and other areas of fire protection engineering. The
E 1591 Guide for Obtaining Data for Deterministic Fire
guide provides information that can be included in terms of
Models
three types of documents.
E 1895 Guide for Determining Uses and Limitations of
4.2 This guide is intended to assist in the understanding,
Deterministic Fire Models
usage, transfer, conversion, and modification of computer
2.2 ANS Standards:
software. If the options and instructions contained in this guide
ANSI/ANS 10.2 Portability of Scientific and Engineering
3 are considered when documentation is prepared, the software
Software
3 should be used more readily for its intended purposes.
ANSI/ANS 10.3 Documentation of Computer Software
4.3 The use of fire models currently extends beyond the fire
research laboratory and into the engineering, fire service, and
legal communities. Sufficient documentation of computer soft-
1
ThisguideisunderthejurisdictionofASTMCommitteeE05onFireStandards
ware for fire models is necessary to ensure that users can judge
and is the direct responsibility of Subcommittee E05.33 on Fire Safety Engineering.
the adequacy of the scientific and technical basis for the
Current edition approved Oct. 1, 2003. Published November 2003. Originally
approved in 1992. Last previous edition approved in 1998 as E 1472–92 (1998).
2
For referenced ASTM standards, visit the ASTM website, www.astm.org, or
4
contact ASTM Customer Service at service@astm.org. For Annual Book of ASTM Available from InterNational Committee for Information Technology Stan-
Standards volume information, refer to the standard’s Document Summary page on dards, c/o Information Technology Industry Council, 1250 Eye Street NW, Suite
the ASTM website. 200, Washington D.C. 20005.
3 5
Available from American Nuclear Society, 555 North Kensington Avenue, Available from Institute of Electrical and Electronics Engineers Standards
LaGrange Park, IL 60526. 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 ----------------------
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.
e1
E 1472–03
models, select the appropriate computer operating environ- 6.2.2 Identify the equivalent version of the program, with
ment, and use the software effectively within the specified the changes made.
limi
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.