Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Puntos 3 y 10, extructura general doc #39

Merged
merged 2 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/images/03_1_contexto-negocio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/03_2_contexto_tecnico.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/10_1_arbol-calidad.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ endif::backend-html5[]




[role="arc42help"]
****
[NOTE]
Expand Down Expand Up @@ -98,4 +97,4 @@ include::src/12_glossary.adoc[]

// horizontal line
***
include::src/about-arc42.adoc[]
include::src/about-arc42.adoc[]
8 changes: 6 additions & 2 deletions docs/src/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,14 @@ See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 docum

****

* Los usuarios podrá registrarse en la aplicación.
* Los usuarios podrán registrarse en la aplicación.
* Los ususarios registrados podrán iniciar su sesión en la aplicación.
* Los usuarios registrados podrán jugar.
* Los usuarios registrados podrán consultar su historial de participación: número de juegos, preguntas acertadas/falladas, tiempos, etc.
* Los usuarios registrados podrán consultar su historial de participación
** Número de juegos
** Preguntas acertadas/falladas
** Tiempo de respuesta y partida


=== Metas de Calidad

Expand Down
32 changes: 30 additions & 2 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ image::03_1_contexto-negocio.png["Diagrama de contexto de negocio"]
|*Sistema*
|_Contiene el frontend y backend de la aplicación._

|*MongoDB*
|_Base de datos para almacenar la información de los usuarios._
|*Base de Datos*
|_Almacenamiento principal del sistema._

|*Usuario*
|_Los usuarios que interactuaran con la aplicación._
Expand Down Expand Up @@ -86,3 +86,31 @@ together with a mapping table showing the relationships between channels and inp
****

image::03_2_contexto_tecnico.png["Diagrama de contexto técnico"]

|===
|Componentes |Explicación

|*Sistema*
|_Contiene el frontend y backend de la aplicación._

|*MongoDB*
|_Base de datos no relacional para el almacenamiento de usuarios._

|*Usuario*
|_Los usuarios que interactuaran con la aplicación._

|*Wikidata API*
|_API de donde obtendremos las preguntas y respuesta correcta para el juego de la aplicación._

|*Javascript*
|_Lenguaje de programación principal de la aplicación._

|*Express JS*
|_Framework para la creación de aplicaciones web en Javascript, utilizado en el backend._

|*React*
|_Biblioteca de Javascript para creación de interfaces de usuario, utilizado en el frontend._

|*Firebase*
|_Plataforma de desarrollo de Google, se utiliza en el login del sistema._
|===
17 changes: 14 additions & 3 deletions docs/src/10_quality_requirements.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-quality-scenarios]]
== Quality Requirements
== Requerimientos de Calidad


[role="arc42help"]
Expand All @@ -25,7 +25,7 @@ See https://docs.arc42.org/section-10/[Quality Requirements] in the arc42 docume

****

=== Quality Tree
=== Árbol de Calidad

[role="arc42help"]
****
Expand All @@ -46,7 +46,9 @@ In any case the tree should include links to the scenarios of the following sect

****

=== Quality Scenarios
image::10_1_arbol-calidad.png["Diagrama de árbol de calidad"]

=== Escenarios de Calidad

[role="arc42help"]
****
Expand All @@ -71,3 +73,12 @@ more precisely down to a level of scenarios that can be discussed and evaluated.
.Form
Tabular or free form text.
****

|===
|*Calidad* |*Escenario* | *Acciones de usuario* | *Respuesta*
|Usabilidad| Un usuario que nunca ha interactuado con la aplicación | El usuario quiere iniciar sesión y posteriormente jugar | La aplicación facilita al usuario iniciar/registrar en la aplicación y posteriormente se le muestra la opción para jugar de forma visual
|Rendimiento| Un usario, un poco impaciente y ya registrado quiere jugar tranquilamente una partida | Empieza la partida y espera a que se procese la pregunta y respuestas | El sistema de obtención de preguntas es ágil y se muestra la pregunta con sus respuestas antes de que el usuario se canse de esperar
|Testeable| Un desarrollador esta realizando una nueva funcionalidad del sistema, pero se equivoca y produce fallos en la aplicación | Igualmente realiza un commit en su rama con el objetivo de incorporar la nueva funcionalidad al sistema | Las pruebas automáticas detectan un error de programación e impide que el problema se propague a la aplicación funcional
|Disponibilidad| Un usuario quiere jugar a las 03:00 AM | El usuario inicializa la aplicación de forma estandar |La aplicación es funcional pese a no ser una hora habitual
|===

Loading