Skip to content

Commit

Permalink
#1 Update 11_technical_risks.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
AlvaroGlezC authored May 14, 2024
1 parent 07f7236 commit c3a8df9
Showing 1 changed file with 31 additions and 12 deletions.
43 changes: 31 additions & 12 deletions docs/src/11_technical_risks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,42 @@ ifndef::imagesdir[:imagesdir: ../images]
[[section-technical-risks]]
== Risks and Technical Debts

=== Technology Risks
This is the compilation of the identified risks ordered by priority that we must minimize or avoid.

[role="arc42help"]
****
.Contents
A list of identified technical risks or technical debts, ordered by priority
[options="header",cols="1,1"]
|===
|Technology| Risk
| JPA | Integrating JPA into your database adapter and compatibility with different databases can be a big risk
| Keycloak | Although it is a powerful security and authentication framework, integrating it into both the backend and the frontend can be challenging and risky
| Docker| Using, building and deploying modules and services with docker carries a significant risk in terms of reliability and time
| Deployment| A deployment is always problematic until it is automated, this process can take time to set up and configure, and this process is also problematic and costly and can be considered a risky process as well. I have also never used azure so the learning curve of deploying in azure and adding continuous integration in azure is growing.
| Grafana and Prometeus| We have never used these tools to monitor a project and we need to adapt to them. A bit like with azure

.Motivation
“Risk management is project management for grown-ups” (Tim Lister, Atlantic Systems Guild.)
* Team risks:

This should be your motto for systematic detection and evaluation of risks and technical debts in the architecture, which will be needed by management stakeholders (e.g. project managers, product owners) as part of the overall risk analysis and measurement planning.
[options="header",cols="1,1"]
|===
|Risk|Explanation
|Being just 1 member1| The difficulty in developing the entire architecture and functionality is infinitely greater for a single person than for a team of 5-7 people
|===

.Form
List of risks and/or technical debts, probably including suggested measures to minimize, mitigate or avoid risks or reduce technical debts.

==== Minimize or avoid risks

.Further Information
[options="header",cols="1,1"]
|===
|Risk|How to avoid or minimize
|Not knowing the technologies|We seek information and practice using them.
|Being only 1 member| Much more work to counter the lack of equipment.
|===

See https://docs.arc42.org/section-11/[Risks and Technical Debt] in the arc42 documentation.

****

=== Technical debts

* Authentication and security with keycloak is implemented, but in the deployment it was necessary to have keycloak with https so it is a problem, which although there is time, may not be solved due to the lack of official certificates. A self-signed certificate will be used just in case.
* The internationalisation was carried out without problems, except for the internationalisation of the questions, as it involves translating them in the wikidata Q&A search itself. Although it is not a problem to have to search for questions in 4 languages, there are categories that are very reduced even to a single question, so it is still up in the air.
* Although multiple optional points of functionality were completed, I had intended to do almost all of them, but due to the short time available it was impossible.
* I would like to improve the logout, as it redirects strangely to the home page for some unknown reason, but I won't be able to look into it before the final delivery.
* Even though the continuous integration of tests is set up and working, for the coverage label, it only picks up the one from the backend since it's the last one analyzed and overrides the others. Although we'll try to fix it before the final delivery, there may not be enough time.

0 comments on commit c3a8df9

Please sign in to comment.