...
| Action Required | Assignee - Task Owner | Link | Done ? | Done Date | Approved? | Approver | Approved Date | Notes |
|---|---|---|---|---|---|---|---|---|
| Phase 1 - Component Level Development and Testing | ||||||||
| Design Document |
|
| ||||||
| Verification and Unit Tests |  | | ||||||
| Performance Assessment | | | ||||||
| Validation Tests | | | ||||||
| Issue Pull Request | | | ||||||
| PR Integrator | assigned integrator | - | integrated date | - | - | - | - | |
| Phase 2 - Coupled System Integration and Testing | ||||||||
| Phase 2 Process Doc | | | ||||||
| Feature's Coupled Performance | | | ||||||
| Feature's Coupled Validation | | | ||||||
| Final Approval to part of ACME model | | - | - | - | - | |||
The Design Document page provides a description of the algorithms, implementation and planned testing including unit, verification, validation and performance testing. Please read Step 1.3 Performance Expectations that explains feature documentation requirements from the performance group point of view.
Design Document
| HTML Comment |
|---|
|
...
| id | Feature_PR |
|---|
...
Overview table for the owner and an approver of this feature
...
1.Name
...
| Expand | |||
|---|---|---|---|
| |||
|
Title: Some descriptive title
Requirements and Design
ACME Group
Date:
Summary
...
Requirements
Requirement: name-of-requirement-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
...
Algorithmic Formulations
Design solution: short-description-of-proposed-solution-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
For each requirement, there is a design solution that is intended to meet that requirement. Design solutions can include detailed technical discussions of PDEs, algorithms, solvers and similar, as well as technical discussion of performance issues. In general, this section should steer away from a detailed discussion of low-level software issues such as variable declarations, interfaces and sequencing.
Design and Implementation
Implementation: short-desciption-of-implementation-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
This section should detail the plan for implementing the design solution for requirement XXX. In general, this section is software-centric with a focus on software implementation. Pseudo code is appropriate in this section. Links to actual source code are appropriate. Project management items, such as svn branches, timelines and staffing are also appropriate. How do we typeset pseudo code?
Planned Verification and Unit Testing
Verification and Unit Testing: short-desciption-of-testing-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?
Planned Validation Testing
Validation Testing: short-desciption-of-testing-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
How will XXX be tested? What observational or other dataset will be used? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?
Planned Performance Testing
Performance Testing: short-desciption-of-testing-here
Date last modified:
Contributors: (add your name to this list if it does not appear)
How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?