Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 967 Bytes

File metadata and controls

39 lines (23 loc) · 967 Bytes

[Feature name]

This design document describe the high level design of a feature. The design document is golden source and reference by one or more features.

1. Background

[brief the background of this feature here.]

2. Architecture

2.1 Project Level Architecture

Project Level Architecture(PA) describes the relationship among apps and packges in this monorepo.

[Describe the project level architecture(PA). Or refer to existing design files.]

2.2 App Level Architecture

App Level Architecture(AA) describes the relationship between file/class/module/method within one app or one packages.

[Describe the app level architecture(AA) feature. Or refer to existing design files]

2.3 Key Design

[Highlight the key classes, methods, mindset or tools]

3. User Stories

3.1 User Story Title

[describe the user story in TDD style here]

  • Given -
  • When -
  • Then -
[draw the technical sequence diagram here]
Loading