This repository has been archived by the owner on Sep 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Project Name | ||
## Software Architecture Documentation | ||
> This template is a simplified version based on the documentation templates from IBM Rational Unified Process (RUP) and arc42.org (https://docs.arc42.org/home/) | ||
> If necessary, you can add more topics related to the architecture design of your application. | ||
### 1. Introduction | ||
#### 1.1 Overview | ||
> What are the selling points of your architecture design? | ||
#### 1.2 Constraints | ||
> Any technical or organizational constraints, conventions (Tips: https://docs.arc42.org/section-2/) | ||
#### 1.3 Definitions, Acronyms and Abbreviations | ||
> Definitions of all terms, acronyms, and abbreviations required to properly interpret this document. | ||
#### 1.4 References | ||
> A complete list of all documents referenced -- hyperlinks to those documents. | ||
### 2. Architecture tactics | ||
> Reference your architecturally significant requirements from Semester 3. | ||
> Revise your architecture tactics from Semester 3. | ||
### 3. Architecture design | ||
> This section specifies the architecture design in various views. | ||
> Minimum requirement: | ||
> - sequence diagram on a component level and necessary description | ||
> - component diagrams and/or package diagrams, and necessary description | ||
#### 3.1 Overview | ||
> A summary of the architecture design -- highlights. | ||
#### 3.2 Runtime view (Tips: https://docs.arc42.org/section-6/) | ||
|
||
#### 3.3 Deployment view (Tips: https://docs.arc42.org/section-7/) | ||
|
||
#### 3.4 ... ... | ||
|