Physical Address
304 North Cardinal St.
Dorchester Center, MA 02124
D6171-97 – Standard Test Method Technical Guide
📜 Scope and Purpose
This standard guide, D6171 (reapproved 2010), outlines the essential components for documenting a groundwater modeling code. Proper documentation includes textual and graphical information captured during the code’s design, development, and maintenance, covering its capabilities, development history, theoretical foundation, operational procedures, and verification. It serves as the principal communication instrument for code developers, maintenance staff, network managers, users, and project managers throughout the software lifecycle.
The guide emphasizes that documentation must be tailored to its audience and may be delivered in printed or electronic form. It is part of a series of ASTM groundwater modeling guides, including D5447, D5490, D5609, D5610, D5611, and D5718. This standard is not prescriptive; it offers options and considerations, relying on professional judgment for its application.
📚 Referenced Standards and Key Terminology
This standard references several ASTM documents that provide context for groundwater modeling. The following table lists the key referenced standards:
| 🟦 Standard | 📝 Title |
|---|---|
| D653 | Terminology Relating to Soil, Rock, and Contained Fluids |
| D5447 | Guide for Application of a Ground-Water Flow Model to a Site-Specific Problem |
| D5490 | Guide for Comparing Ground-Water Flow Model Simulations to Site-Specific Information |
| D5609 | Guide for Defining Boundary Conditions in Ground-Water Flow Modeling |
| D5610 | Guide for Defining Initial Conditions in Ground-Water Flow Modeling |
| D5611 | Guide for Conducting a Sensitivity Analysis for a Ground-Water Flow Model Application |
| D5718 | Guide for Documenting a Ground-Water Flow Model Application |
Key terms defined in the standard include computer code (the assembly of numerical techniques, bookkeeping, and control language that represents the model from input to output) and functionality (the set of functions and features the code offers for geometry, processes, boundary conditions, and analytical capabilities).
💻 Documentation Audiences and Formats
The guide addresses diverse audiences—from code developers and maintenance staff to network managers and end-users—and covers all aspects from design through maintenance. Both printed and electronic documentation are considered, with electronic forms facilitating easier updates and accessibility.
💡 Tip: Documentation acts as the principal instrument for communication throughout the software lifecycle, ensuring all stakeholders have a clear understanding of the code’s capabilities and limitations.
⚠️ Note: This guide is not intended to be all-inclusive; it offers options and considerations without prescribing a specific course of action. Professional judgment must be applied when using it for documentation tasks.
❓ Frequently Asked Questions
🔍 What is the scope of ASTM D6171?
The standard covers suggested components for documenting groundwater modeling codes, including textual and graphical information about capabilities, development history, theory, operation, and verification, intended for use by developers, maintainers, and users.
💡 Why is documentation important for groundwater modeling codes?
Documentation serves as the primary communication tool among developers, users, and managers, ensuring that code capabilities, theoretical foundations, and operational procedures are well-understood and properly maintained over time.
⚡ What other ASTM standards are referenced in D6171?
Referenced standards include D653 for terminology, D5447 for model application, D5490 for comparing simulations, D5609 for boundary conditions, D5610 for initial conditions,