A sample design brief structure

Jira

https://zenuml.atlassian.net/browse/PB-153

Doc Status

APPROVED

Designer

@Peng Xiao

Stakeholders

 

1. Document purpose

This document provides an overview of the design intended to detail the architectural design.

2. Overview

2.1 Feature overview

2.2 Solution context

3. Solution

3.1 Scope

3.1.1 Out of scope

3.2 High-level design

3.2.1 Existing state

3.2.2 Proposed state

3.3 System components

3.4 Alternative solutions

4. Design Elaboration

4.1 DB

4.2 Sequence diagrams

5. Design Considerations

5.1 Design decisions

5.2 Assumptions

5.3 Dependencies

5.4 Risk and issues

5.5 Open items

5.6 Infrastructure

5.7 Security

5.7.1 Connectivity

5.7.2 Data classification

5.8 Non-functional specification

5.9 Performance and volumes

6. Appendix

6.1 Glossary

6.2 Attachments