Architecture Review Checklist

Architecture review checklist for pull requests in Markdown.

Architecture review Markdown template

Traceability is important throughout the entire development process. To simplify traceability for architectural review, use the following template when reviewing via pull requests. The template is the checklist translated into markdown format.

- [ ] Is the content updated according to all relevant input requirements?
- [ ] Is the described functionality in accordance with relevant input Architecture Specifications?
- [ ] Are all _major_ software/hardware components identified and their relevant interfaces defined?
- [ ] Does the architecture specification have the right level of abstraction?
- [ ] Is the functional decomposition well described?
- [ ] Is the dynamic behavior well described?
- [ ] Is the information model described?
- [ ] Is the deployment described?
- [ ] Are architecture decisions described?
- [ ] Do all entities in the architecture have consistent names?

---

Are sufficiently precise (i.e. sufficient quantity to be useful) descriptions put on:

- [ ] a) compatibility
- [ ] b) standard compliance
- [ ] c) availability
- [ ] d) configuration
- [ ] e) assumptions and dependencies

---

- [ ] Is all mitigation of risks described in the threat model covered?
- [ ] Is the architecture considering best practices?
- [ ] Is the architecture feasible for refinement to a functional design (Description of Function)?
- [ ] Is reuse of existing trusted and verified software modules/libraries considered?
- [ ] If applicable, is the architecture structured so that reuse is possible for other components or products?

Azure DevOps template

Pull request template assists a review when performing the review. When using Azure DevOps, the markdown template can be used as a pull request template. Copy the markdown template content into a markdown file at this location in the architecture code repository:

.azuredevops\pull_request_template\architecture review.md

For more details regarding templates in Azure DevOps, see Improve pull request descriptions using templates.