Merge pull request #182 from Arquisoft/uo287998

Actualización README.md y documentación

README.md

@@ -11,10 +11,16 @@ Contributors:
 - <a href="https://github.com/UO277382"><img src="https://img.shields.io/badge/Laureano-fuchsia?logo=github"></a>
 - <a href="https://github.com/marcosMachadoMenendez"><img src="https://img.shields.io/badge/Marcos-fuchsia?logo=github"></a>
 
+Play here! -> [PLAY WIQ](http://74.249.118.115:3000 "WIQ")
+Access the documentation -> [DOCS](https://arquisoft.github.io/wiq_es3a/)
+Swagger API -> [API UI](http://74.249.118.115:8000/api-doc)
+API Questions -> [Questions](http://74.249.118.115:8000/questions)
+API Users -> [Users](http://74.249.118.115:8000/users)
+
 ## Guide for USERS
-You can access the game through the following URL -> [WIQ_es3a](http://74.249.118.115:3000 "WIQ")
 
-------------
+### Gameplay Tutorial
+[Click here and learn how to PLAY WIQ](https://tinyurl.com/shmd92c2)
 
 ### Gameplay Instructions
 To play, you'll need to follow these steps:
@@ -34,8 +40,6 @@ To play, you'll need to follow these steps:
 
 After playing, you'll be able to view your game statistics and compare yourself with other users on a ranking.
 
-------------
-
 ## Guide for DEVELOPERS
 
 This repo is a basic application composed of several components.

docs/src/01_introduction_and_goals.adoc

@@ -4,14 +4,26 @@ Wiq es un proyecto desarrollado por la Universidad de Oviedo, desarrollado por l
 La aplicación consiste en una serie de preguntas de diferentes categorías y temas generadas automáticamente a partir de datos de Wikidata.
 Los miembros del equipo de desarrollo son los siguientes:
 
+* link:https://github.com/UO289659[Carmen Espinosa Martínez] 
+* link:https://github.com/UO287998[Ángel David Fernández Vior] 
+* link:https://github.com/UO285267[Felipe García Gómez] 
+* link:https://github.com/UO277382[Laureano Enrique Álvarez] 
+* link:https://github.com/marcosMachadoMenendez[Marcos Mahado Menéndez] 
 
 === Requisitos
+* Aplicación web con integración y despliegue continuos.
 * Los usuarios podrán registrarse en el sistema y consultar el histórico de participaciones.
 * Las preguntas serán generadas automáticamente con datos de Wikidata.
 * Las preguntas tendrán un tiempo límite.
 * Cada pregunta tendrá una respuesta correcta y varias incorrectas, todas ellas generadas automáticamente.
 * El sistema dispondrá de una API para acceder a la información de las preguntas y los usuarios.
 
+==== Otros requisitos
+* La aplicación incluye diferentes temáticas sobre las preguntas. Esto permite que los usuarios puedan elegir que temática responder.
+* El sistema tiene varios modos de juego que podrán ser seleccionados por los jugadores.
+* Se permite ajustar parámetros de juego como el tiempo o el número de preguntas.
+* Existe un ranking de todos los usuarios de la aplicación donde se pueden ordenar por las estadísticas de cada uno.
+
 === Objetivos de calidad
 [options="header",cols="1,2,4"] 
 
@@ -33,6 +45,14 @@ Los miembros del equipo de desarrollo son los siguientes:
 | *4*
 | *_Testeabilidad_*
 | Se utilizarán pruebas unitarias para garantizar el buen funcionamiento de la aplicación. 
+
+| *5*
+| *_Rendimiento_*
+| Uno de los objetivos será que los tiempos de carga sean rápidos, con tiempos de respuesta bajos, para lograr una experiencia fluida durante la navegación.
+
+| *6*
+| *_Disponibilidad_*
+| Es importante que la aplicación esté disponible y accesible para los usuarios cuando la necesiten. Se intentará minimizar el tiempo de inactividad de la aplicación mediante un despliegue continuo
 |=== 
 
 === Stakeholders
@@ -41,8 +61,8 @@ Los miembros del equipo de desarrollo son los siguientes:
 |Nombre|Descripción|Expectativas
 
 | *_Equipo de desarrollo_*
-| 
-| El equipo de desarrollo esta formado por los estudiantes anteriormente indicados, y deberían desarrollar la aplicación con éxito en base a la documentación entregada por la empresa.
+| El equipo de desarrollo esta formado por los estudiantes miembros de este grupo
+| Deberían desarrollar la aplicación con éxito en base a los requisitos puestos por la empresa
 
 | *_Usuarios_*
 | Personas que utilicen la aplicación.
@@ -52,7 +72,7 @@ Los miembros del equipo de desarrollo son los siguientes:
 | Empresa que contrata el desarrollo de la aplicación.
 | Se espera que la aplicación cumpla con los requisitos mencionados anteriormente.
 
-| *RTVE*
+| *_RTVE_*
 | Empresa que contrata
 | Tiene las mismas expectativas que que el equipo de desarrollo que funcione todo correctamente y sin ningún fallo
 |=== 

docs/src/11_technical_risks.adoc

@@ -10,7 +10,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 |Despliegue en servidor|Puede haber errores de conexión con la máquina que despliega la aplicación. Además, si la desplegamos en servicios como Azure o AWS, la aplicación depende de una fuente externa, por lo que, podría darse la situación de no poder desplegar la web por una causa ajena.
 
-|Inconsistencias de datos| Al utilizar Wikidata para responder sacar la respuesta a preguntas, puede haber ciertas inconsistencias en los datos. Estos son actualizados por usuarios independientes y puede ocurrir que exista alguna respuesta que no tiene algún dato actualizado o incluso datos erróneos
+|Inconsistencias de datos| Al utilizar Wikidata para sacar la respuesta a preguntas, puede haber ciertas inconsistencias en los datos. Estos son actualizados por usuarios independientes y puede ocurrir que exista alguna respuesta que no tiene algún dato actualizado o incluso datos erróneos
 
 |Utilizar dependencias antiguas/inseguras| Puede ser un problema utilizar librerías o frameworks antiguos, expuestos a vulnerabilidades de seguridad o que dejen de funcionar, ya que, han sido modificados.
 
@@ -24,4 +24,6 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 |Usabilidad en la web| Se intentará que la aplicación sea lo más usable posible y que pueda llegar al máximo número de personas y rangos de edad; evitando colores parecidos, mala legibilidad y haciendo la aplicación lo más intuitiva posible.
 
+|Rendimiento depende de Wikidata| Puede darse el caso de que al hacer una consulta a Wikidata para obtener alguna pregunta, esta petición se demore mucho tiempo, siendo esto un problema que se ha de intentar subsanar en la medida de lo posible, pero que no está en manos de los desarrolladores.
+
 |===

docs/src/12_glossary.adoc

@@ -28,4 +28,22 @@ ifndef::imagesdir[:imagesdir: ../images]
 |Stakeholders
 |Son el conjunto de personas o entidades que tienen interés o influencia de alguna manera sobre un proyecto
 
+|NodeJS
+|Es un entorno de tiempo de ejecución de JavaScript que permite ejecutar código JavaScript en el servidor. Node.js es especialmente conocido por su capacidad para crear aplicaciones de red escalables y de alta velocidad.
+
+|React
+|Es una biblioteca de JavaScript que se utiliza para construir interfaces de usuario (UI) interactivas y dinámicas para aplicaciones web y móviles.
+
+|Integración continua
+|Es una práctica de desarrollo de software que implica integrar cambios de código en un repositorio compartido de forma frecuente y regular, idealmente varias veces al día.
+
+|Despliegue continuo 
+|Implica automatizar el proceso de implementación de software en un entorno de producción una vez que se pasa satisfactoriamente a través de las pruebas automatizadas.
+
+|Automatización
+|Es el proceso de configurar y programar tareas repetitivas para que se ejecuten de forma automática sin intervención manual. Esto implica definir y ejecutar flujos de trabajo que realizan acciones específicas, como pruebas de código, compilación de aplicaciones, despliegue automático...
+
+|GitHub
+|Es una plataforma de desarrollo de software basada en la web que ofrece control de versiones y herramientas de colaboración para desarrolladores.
+
 |===