ASTM E1472-07
(Guide)Standard Guide for Documenting Computer Software for Fire Models (Withdrawn 2011)
Standard Guide for Documenting Computer Software for Fire Models (Withdrawn 2011)
SIGNIFICANCE AND USE
This guide provides recommendations for writers of user’manuals and other documents for computer software prepared for scientific and engineering computations in fire models and other areas of fire protection engineering. The guide provides information that can be included in terms of three types of documents.
This guide is intended to assist in the understanding, usage, transfer, conversion, and modification of computer software. If the options and instructions contained in this guide are considered when documentation is prepared, the software should be used more readily for its intended purposes.
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 software for fire models is necessary to ensure that users can judge the adequacy of the scientific and technical basis for the models, select the appropriate computer operating environment, and use the software effectively within the specified limitations. Adequate documentation will help prevent the unintentional misuse of fire models.
Additional guidelines on documentation can be found in ANSI/ANS 10.3 and ANSI/IEEE 1063.
ANSI/ANS 10.2 and 10.5 provide guidelines for programming to ease the portability of the software and meet user needs.
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 There are no numerical values stated in this standard. It is recommended that SI units be the standard in the documentation and development of fire models.
1.4 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.5 This fire standard cannot be used to provide quantitative measures.
WITHDRAWN RATIONALE
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.
Formerly under the jurisdiction of Committee E05 on Fire Standards and Subcommittee E05.33 on Fire Safety Engineering, this guide was withdrawn without replacement in July 2011. This standard is being withdrawn without replacement because it completed its usefulness when it provided SFPE with a starting point for their own engineering guides and standards on these points. This standard does not rely on expertise in ASTM's areas of strength but is more appropriately the subject of SFPE guides and standards, in that SFPE members will be all or nearly all of the users of such guides.
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
Designation:E1472–07
Standard Guide for
1
Documenting Computer Software for Fire Models
This standard is issued under the fixed designation E1472; 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 (´) indicates an editorial change since the last revision or reapproval.
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 Dic-
and engineering computations in fire models and other areas of
4
tionary 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 There are no numerical values stated in this standard. It
5
ANSI/IEEE 1063 Software User Documentation
is recommended that SI units be the standard in the documen-
tation and development of fire models.
3. Terminology
1.4 This standard does not purport to address all of the
3.1 Definitions—Definitions used in this guide are in accor-
safety concerns, if any, associated with its use. It is the
dance with Terminology E176, unless otherwise indicated.
responsibility of the user of this standard to establish appro-
ANSI/INCITS X3.172 and ANSI/IEEE 610.12 include defini-
priate safety and health practices and determine the applica-
tions of some technical terms used in this guide.
bility of regulatory limitations prior to use.
1.5 This fire standard cannot be used to provide quantitative
4. Significance and Use
measures.
4.1 This guide provides recommendations for writers of
user’s manuals and other documents for computer software
2. Referenced Documents
2
prepared for scientific and engineering computations in fire
2.1 ASTM Standards:
models and other areas of fire protection engineering. The
E176 Terminology of Fire Standards
guide provides information that can be included in terms of
E1355 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,
E1591 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
E1895 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
the adequacy of the scientific and technical basis for the
models, select the appropriate computer operating environ-
1
ThisguideisunderthejurisdictionofASTMCommitteeE05onFireStandards
ment, and use the software effectively within the specified
and is the direct responsibility of Subcommittee E05.33 on Fire Safety Engineering.
limitations. Adequate documentation will help prevent the
Current edition approved April 1, 2007. Published April 2007. Originally
unintentional misuse of fire models.
approved in 1992. Last previous edition approved in 2005 as E1472–05. DOI:
10.1520/E1472-07.
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 ----------------------
E1472–07
4.4 Additional guidelines on documentation can be found in 6.3.1 Provide instructions for
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.