Skip to content

Commit 910ba24

Browse files
committed
added recommended links
added few more diagrams
1 parent 3766bc7 commit 910ba24

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,22 @@ This document contains Solution Architecture Process and Solution Architecture D
44
Basically the SA working process consist of the main phases:
55
- [Requirement gathering](requirements.md)
66
- [Stakeholders](./requirements.md#stakeholder-list-creating)
7-
- [Stakeholders](./requirements.md#stakeholder-list-creating)
7+
- [Functional requirements](./requirements.md#functional-requirements)
8+
- [Non Functional requirements](./requirements.md#non-functional-requirements)
9+
- [Constraints](./requirements.md#constraints)
10+
- [Assumptions](./requirements.md#assumptions)
811
- [Solution Architecture Design](solution-architecture-design.md)
12+
- [Quality Attributes](./solution-architecture-design.md#solution-architecture-quality-attributes)
13+
- [Architecture Significant Requirements](./solution-architecture-design.md#architecture-significant-requirements)
14+
- [Current Architecture](./solution-architecture-design.md#current-architecture)
915
- Time estimation and WBS
1016
- PoC creating
1117
- Development
1218
- Migration
19+
20+
##### Recommended links/books
21+
22+
- [The 4 + 1 View Model of Software Architecture by Philippe Kruhten](https://www.cs.ubc.ca/~gregor/teaching/papers/4+1view-architecture.pdf)
23+
- Rational Unified Process
24+
- [Software Engineering Institute](https://www.amazon.com/Documenting-Software-Architectures-Views-Beyond/dp/0321552687/ref=sr_1_2?crid=3QJBR916FNGJU&dchild=1&keywords=documenting+software+architectures+views+and+beyond&qid=1601614456&sprefix=documenting+softwa%2Caps%2C174&sr=8-2)
25+
- [C4 model by Simon Brown](https://leanpub.com/software-architecture-for-developers/read#c4)

images/combined-style-diagram.png

55.3 KB
Loading

solution-architecture-design.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
There is no good or bad solution architecture in general. Architecture can just more or less fit for the purpose it was designed for. And if the particular architecture fits a customer needs so we can say that this solution architecture is good. So the bottom line is - you can evaluate solution architecture only in the context of particular declared goals.
22

3-
# Solution Architecture Quality
3+
# Solution Architecture Quality Attributes
44
The goal is to convert all Functional Requirements (FR), NFR, Constraints, Assumptions to Quality Attributes. More importantly, you should define measurable metrics for those quality attributes.
55

66
A quality attribute is a measurable or testable property of the system that is used to indicate how well the system satisfies the needs of its stakeholders.
@@ -45,7 +45,7 @@ Metrics:
4545
- Miss rate
4646
- etc.
4747

48-
# Architecture Significant Requirements (ASR)
48+
# Architecture Significant Requirements
4949
This kind of requirement has a profound effect on architecture. ASR can be collected from FR, NFR, Interviewing Stakeholders, by understanding Business Goals, by conduction Quality Attribute workshops. Based on this document you should create a Utility Tree with ASRs.
5050
![Image of UtilityTree](images/UtilityTree.jpg)
5151
[Utility Tree gathering process in details](https://arnon.me/2010/05/utility-trees-hatching-quality-attributes)
@@ -58,7 +58,13 @@ This part must be implemented after you have all requirements and you have alrea
5858
- Solution cross-cutting concerns
5959

6060
#### High-level solution structure
61-
SEI has the recommendation to document it with one or multiple the next views: Module style, Component-and-connector style, Allocation style, Combined-style, and any other notations
61+
High-level solution structure - SEI has the recommendation to document it with one or multiple the next views: Module style, Component-and-connector style, Allocation style, Combined-style, and any other notations.
62+
This is a high-level map of the solution. The layers can be used for introduction tiers.
63+
All solution components must be shown: services, applications by nature, data storages, buses, caches and etc.
64+
65+
In a diagram can be described the next:
66+
- solution components
67+
-
6268

6369
###### module style diagram [source](https://www.researchgate.net/figure/Module-Diagram-of-the-System_fig2_331662435)
6470

@@ -72,6 +78,10 @@ SEI has the recommendation to document it with one or multiple the next views: M
7278

7379
![Image of UtilityTree](images/Example-Function-Allocation-FA-Diagram.png)
7480

81+
###### Combined style diagram [source](https://www.researchgate.net/figure/ALEF-components-overview-three-tiers-architecture-data-application-and-presentation_fig5_283412581)
82+
83+
![Image of CombinedStyle](images/combined-style-diagram.png)
84+
7585
#### Structure of the solution components and their technology stacks
7686
Can be represented as a table under a component diagram with the list of components and technology stack used for those components
7787

@@ -133,6 +143,6 @@ For simplicity, you can create a table with a list of stakeholders and diagram v
133143
|Product owner |Decompositions View |N/A | Deployment View |
134144
|Maintenance engineer |Decompositions View |N/A | Deployment View |
135145
|End User |Shows users list |N/A | N/A |
136-
|Developer |Decompositions View |N/A | Deployment View |
146+
|Developer |Class View |Component View | Deployment View |
137147
|QA |Decompositions View |N/A | Deployment View |
138148
|PM |N/A |N/A | Work assignment view |

0 commit comments

Comments
 (0)