From fbf443b1615c40cd027d3f23bfcc68eb7a5e9e1f Mon Sep 17 00:00:00 2001 From: Pedro Limeres <113518495+plg22@users.noreply.github.com> Date: Tue, 13 Feb 2024 14:05:05 +0100 Subject: [PATCH] Section 6 and bug corrected --- .vscode/settings.json | 1 + docs/src/04_solution_strategy.adoc | 1 - docs/src/06_runtime_view.adoc | 76 ++++++++++-------------------- docs/src/12_glossary.adoc | 1 + 4 files changed, 28 insertions(+), 51 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/docs/src/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc index 783b6c7..8576b37 100644 --- a/docs/src/04_solution_strategy.adoc +++ b/docs/src/04_solution_strategy.adoc @@ -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. -**** diff --git a/docs/src/06_runtime_view.adoc b/docs/src/06_runtime_view.adoc index e10f375..a459e97 100644 --- a/docs/src/06_runtime_view.adoc +++ b/docs/src/06_runtime_view.adoc @@ -3,63 +3,39 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-runtime-view]] == Runtime View +=== -[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. - -**** - -=== +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 +---- -* __ -* __ +=== -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 ---- -=== - -=== ... - === diff --git a/docs/src/12_glossary.adoc b/docs/src/12_glossary.adoc index 1709577..faff791 100644 --- a/docs/src/12_glossary.adoc +++ b/docs/src/12_glossary.adoc @@ -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.