chore: fixing some tables, plantuml diagrams and writing a title for … #54
Conversation
…the documentation
gony02
requested review from
jjgancfer,
Toto-hitori and
sergiorodriguezgarcia
and removed request for
sergiorodriguezgarcia
There was a problem hiding this comment.
In general quite good! I would appreciate if you could modify the glossary as well, because we had some feedback about not having to describe what React, SpringBoot and other technologies are and maybe we should describe what a Question, Answer or Game is instead
| | Compatibility | The system must be compatible with various web browsers and devices, ensuring a seamless experience for users regardless of their choice of platform. It has to be well-optimized for different screen sizes and functionalities. | ||
| | Transferability | The system must allow for easy transfer of user data and game-related information through its APIs. | ||
| | Reliability | The system should be reliable in generating questions from Wikidata, ensuring that questions are accurate and diverse. The system shall handle user registrations, logins, and game data storage without errors. | ||
| | Availability | The system shall be available 99.99% of the time a user tries to access it. |
There was a problem hiding this comment.
please lower this to 99%, 99.99% can only be achieved by huge companies and means only not having it available for 52 minutes in a year which may be too little?
There was a problem hiding this comment.
I agree with reducing the availability as I believe that it is too high.
About the glossary I think we can all discuss which terms should be defined.
There was a problem hiding this comment.
I agree with lowering the number; I think 99.99% is too big of a number (99% means an estimated downtime of a little above three days and a half). Also, consider mentioning this would be downtime not caused by the hosting service, as we do not have much control over that.
There was a problem hiding this comment.
I also believe 99.99% is way too much for our capability. In my opinion 99% is a good goal for us.
There was a problem hiding this comment.
Please, see the requested changes in the comments of the @Toto-hitori's review.
|
I have been making necessary changes to the documentation. I replaced png files with plantuml code. Additionally, I changed the title of the documentation to make it more personal. And lastly, I modified some tables.