Skip to content

Commit

Permalink
Section 6 and bug corrected
Browse files Browse the repository at this point in the history
  • Loading branch information
plg22 committed Feb 13, 2024
1 parent 027dfcd commit fbf443b
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 51 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 0 additions & 1 deletion docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,3 @@ The production branch contains the work in production right now, from where ever
* *Whatsapp*: will allow us to be in constant communication for helping each other out whenever needed.
* *Discord*: useful for making unofficial meetings and making decisions whenever is impossible for all of us to be present in an specific place.

****
76 changes: 26 additions & 50 deletions docs/src/06_runtime_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,63 +3,39 @@ ifndef::imagesdir[:imagesdir: ../images]
[[section-runtime-view]]
== Runtime View

=== <User's Login>

[role="arc42help"]
****
.Contents
The runtime view describes concrete behavior and interactions of the system’s building blocks in form of scenarios from the following areas:

* important use cases or features: how do building blocks execute them?
* interactions at critical external interfaces: how do building blocks cooperate with users and neighboring systems?
* operation and administration: launch, start-up, stop
* error and exception scenarios
Remark: The main criterion for the choice of possible scenarios (sequences, workflows) is their *architectural relevance*. It is *not* important to describe a large number of scenarios. You should rather document a representative selection.
.Motivation
You should understand how (instances of) building blocks of your system perform their job and communicate at runtime.
You will mainly capture scenarios in your documentation to communicate your architecture to stakeholders that are less willing or able to read and understand the static models (building block view, deployment view).
.Form
There are many notations for describing scenarios, e.g.
* numbered list of steps (in natural language)
* activity diagrams or flow charts
* sequence diagrams
* BPMN or EPCs (event process chains)
* state machines
* ...
.Further Information
See https://docs.arc42.org/section-6/[Runtime View] in the arc42 documentation.
****

=== <Runtime Scenario 1>
Sequence diagram for showing the process of a user logging in:

[plantuml,"Login diagram",png]
----
actor User
database DB
User -> FrontEnd: Request login
FrontEnd -> UsersService: loginUser()
UsersService -> DB: checkUserData()
DB -> UsersService: Confirm data
UsersService -> UsersService: login()
UsersService -> FrontEnd: Confirm login
----

* _<insert runtime diagram or textual description of the scenario>_
* _<insert description of the notable aspects of the interactions between the
building block instances depicted in this diagram.>_
=== <User's sign up>

It is possible to use a sequence diagram:
Sequence diagram for showing the process of a user creating an account:

[plantuml,"Sequence diagram",png]
[plantuml,"Sign Up diagram",png]
----
actor Alice
actor Bob
database Pod as "Bob's Pod"
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice --> Pod: Store route
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
actor User
database DB
User -> FrontEnd: Request sign up
FrontEnd -> UsersService: registerUser()
UsersService -> DB: checkCredentialsExist()
DB -> UsersService: Confirm data
UsersService -> DB: CreateUserData()
DB -> UsersService: Confirm data
UsersService -> UsersService: signUp()
UsersService -> FrontEnd: Redirect to login page
----

=== <Runtime Scenario 2>

=== ...

=== <Runtime Scenario n>
1 change: 1 addition & 0 deletions docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
== Glossary

[role="arc42help"]

****
.Contents
The most important domain and technical terms that your stakeholders use when discussing the system.
Expand Down

0 comments on commit fbf443b

Please sign in to comment.