└── README.md /README.md: -------------------------------------------------------------------------------- 1 | # Software Architecture Document Template 2 | 3 | > Give an overview of the high level requirements 4 | 5 | Add text here 6 | 7 | ## User Roles and Reponsibilities 8 | 9 | > Document roles and responsibilities of the each user type 10 | 11 | Add text here 12 | 13 | ## Constraints 14 | 15 | > Any constraint that you need to keep in mind for your design 16 | > 17 | > Examples: 18 | > 19 | > 1. Technology constraints 20 | > 2. Cost constraints 21 | > 3. Time constraints 22 | 23 | Add text here 24 | 25 | ## Assumptions 26 | 27 | > Any assumptions that you have made while coming up with the design 28 | 29 | Add text here 30 | 31 | ## Business processes 32 | 33 | > Important business processes that you have considered while documenting the design 34 | 35 | Add text here 36 | 37 | ## Non-functional Requirements (Quality Attributes) 38 | 39 | > Most important quality attributes based on the business goals 40 | 41 | Add text here 42 | 43 | ### Back of the envelope calculations 44 | 45 | > Do quick calculations for storage needs, read vs writes, etc. 46 | 47 | Add text here 48 | 49 | ## Functional Layer Diagram 50 | 51 | > List of functional components that will make the system. Which actor will work on which functional part. 52 | 53 | Add text here 54 | 55 | ## Architecture Style 56 | 57 | > Which architecture style you are proposing to build the application 58 | 59 | Add text here 60 | 61 | ## Solution Context Diagram 62 | 63 | > This is a high level context diagram that shows system as a black box, its main user personas, and external integrations 64 | 65 | Add text here 66 | 67 | ## Solution Diagram 68 | 69 | > In this section you create the solution diagram showing different components that make the system. This is a zoom-in view of the system you are building. 70 | 71 | Add text here 72 | 73 | ## Technology Stack 74 | 75 | > The list of technologies that you will use to build the system and the reason you choose them. 76 | > 77 | > These include: 78 | > * Technologies 79 | > * API Style 80 | > * Cloud or on-premise 81 | 82 | Add text here 83 | 84 | ## Architecture Decisions 85 | 86 | > Important architecture decision that you want development team to follow 87 | 88 | Add text here --------------------------------------------------------------------------------