-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 parent
406fc04
commit 46ee8a3
Showing
3 changed files
with
43 additions
and
76 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 |
|---|---|---|
| @@ -1,78 +1,9 @@ | ||
| # Software Architecture | ||
| # SW Documentation | ||
|
|
||
| The following section describes the high level software architecture | ||
| ## Deployment | ||
|
|
||
| ## Use Cases | ||
|  | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| !theme materia | ||
| left to right direction | ||
| ## Architecture | ||
|
|
||
| actor user as user | ||
| package Usecases{ | ||
| usecase UC_help as "print command overview to console" | ||
| usecase UC_import as "import something" | ||
| usecase UC_export as "export something" | ||
| } | ||
| user --> UC_help : 'help' | ||
| user --> UC_import : 'import' | ||
| user --> UC_export : 'export' | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Context Diagram | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| top to bottom direction | ||
| skinparam Linetype ortho | ||
| package "example"{ | ||
| [main] as main | ||
| [cmd_import] as import | ||
| [cmd_export] as export | ||
| } | ||
| database filesystem { | ||
| file "test data" as test_data | ||
| file "JSON file" as file | ||
| } | ||
| main <.down. import : <<flow>> | ||
| main .down.> export : <<flow>> | ||
| export ...down.> file : <<flow>>\n<<create>> | ||
| import ....> test_data : <<flow>>\n<<read>> | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Class Diagram | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| Object <|-- ArrayList | ||
| Object : equals() | ||
| ArrayList : Object[] elementData | ||
| ArrayList : size() | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Sequence Diagram | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| Alice -> Bob: Authentication Request | ||
| Bob --> Alice: Authentication Response | ||
| Alice -> Bob: Another authentication Request | ||
| Alice <-- Bob: Another authentication Response | ||
| @enduml | ||
| ``` | ||
|  |
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,36 @@ | ||
| @startuml DeploymentDiagram | ||
|
|
||
| node "Jira" <<virtual-machine>> as jira_vm { | ||
| node "Jira server" as jira_server { | ||
| database "Jira database" as jira_db | ||
| } | ||
|
|
||
| interface "Jira REST API" as jira_rest_api | ||
| jira_server -- jira_rest_api | ||
| } | ||
|
|
||
| node "Continuous integration server" <<virtual-machine>> { | ||
| package "Scripts" { | ||
| component "pyJiraCli" as jira_cli #White | ||
| component "pyMetricCli" as metric_cli #White | ||
| component "pyProfileMgr" as profile_mgr | ||
| ProfileMgr - [profile_mgr] | ||
| } | ||
|
|
||
| folder Filesystem { | ||
| file "Profile data" as profile_data_files | ||
| } | ||
|
|
||
| jira_cli -> ProfileMgr | ||
| metric_cli --> ProfileMgr | ||
| profile_mgr -- profile_data_files | ||
| } | ||
|
|
||
| jira_rest_api )-- profile_mgr | ||
|
|
||
| ' Notes | ||
| note top of jira_server | ||
| Issue tracking system | ||
| end note | ||
|
|
||
| @enduml |
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