RI+Dev+Process+Appendix+A+-+Design+Review+Checklist

=Appendix A – Design Review Checklist=

Design Review Checklist
The following items must be evaluated in order to conduct a Design Review. All items must be approved before the proposed design is approved.

Satisfies requirement and/or addresses issue (always)
The proposed design must satisfy all requirements associated with the task, or address all aspects of the defect. A design that accounts for only a part of the requirements or solves only a part of the defect is not acceptable.

Conformance to architecture (always)
The design must conform to the system architecture in the following ways.
 * Integrate with the system as prescribed.
 * Specify packaging in conformance with the overall packaging conventions.
 * Use abstraction to loosen coupling with dependencies that may be variable in the real world.

Conformance to module design (always)
The design must be in harmony with the design of the module in which it will be implemented.

Conformance to established design patterns (sometimes)
If the issue description or design theory of operation pertains to a known problem space for which a design pattern has been published, then the design must follow that pattern.

Prose description of design (always)
A narrative description of the design is required. If the issue is a task, then the description should include succinct material concerning the objective, theory of operation, solution details, and any reuse opportunities used or created. If the issue is a defect, then the description should include statements of the cause of the defect, the proposed solution, and how the solution will resolve the defect.

UML Diagrams (sometimes)
If the design requires the creation of new classes, new class relationships, new interactions, or substantial changes to any of the foregoing, then the design to be reviewed must include UML diagrams depicting the classes involved, their relationships, and their interactions. In this case, the following UML diagram types are required. Other types of UML diagrams may be included as necessary.
 * Class or Composite Structure diagram showing details of new or changed classes and showing relationships among new/changed and existing classes.
 * Communication or Sequence diagram showing details of the flow of control and data among participating objects.

Conformance to process (always)
At this point in the process, the following criteria must be met.
 * The proposed design must be associated with at least one planned task in the issue-tracking system.
 * The status value of the task must show that it is in progress.
 * The design materials to be reviewed must be associated with the task in the issue-tracking system.

Return to S&I Framework RI Development Process