Merge pull request #22 from Arquisoft/uo287998

Apartado 8 de la documentacion V 0.1 , cambio titulo, tabla contenidos y glosario documentacion

docs/index.adoc

@@ -6,12 +6,12 @@
 // configure EN settings for asciidoc
 include::src/config.adoc[]
 
-= image:arc42-logo.png[arc42] Template
+= image:arc42-logo.png[arc42] WIQ-DOCUMENTACIÓN
 :revnumber: 8.2 EN
 :revdate: January 2023
 :revremark: (based upon AsciiDoc version)
 // toc-title definition MUST follow document title without blank line!
-:toc-title: Table of Contents
+:toc-title: Tabla de contenidos
 
 //additional style for arc42 help callouts
 ifdef::backend-html5[]

docs/src/08_concepts.adoc

@@ -1,73 +1,34 @@
 ifndef::imagesdir[:imagesdir: ../images]
 
 [[section-concepts]]
-== Cross-cutting Concepts
+== Conceptos tranversales
 
+=== _Seguridad_
 
-[role="arc42help"]
-****
-.Content
-This section describes overall, principal regulations and solution ideas that are relevant in multiple parts (= cross-cutting) of your system.
-Such concepts are often related to multiple building blocks.
-They can include many different topics, such as
+_Es un factor muy importate a tener en cuenta, ya que, al tener un registro de usuarios debemos poder guardar sus contraseñas, entre otras cosas, sin perderlas y sin que puedan ser descubiertas. Debemos intentar prevenir cualquier ataque y asegurar la integridad de los datos._
 
-* models, especially domain models
-* architecture or design patterns
-* rules for using specific technology
-* principal, often technical decisions of an overarching (= cross-cutting) nature
-* implementation rules
+=== _Persistencia de datos_
 
+_La gestión y almacenamiento de datos de usuarios, incluyendo historiales de juegos y resultados, así como datos de preguntas generadas, es un aspecto crítico que abarca múltiples partes de la aplicación, desde la base de datos hasta la lógica de acceso a datos. Para ello utilizaremos MongoDB, una base de datos NoSQL._
 
-.Motivation
-Concepts form the basis for _conceptual integrity_ (consistency, homogeneity) of the architecture. 
-Thus, they are an important contribution to achieve inner qualities of your system.
+=== _Generación de preguntas automática_
 
-Some of these concepts cannot be assigned to individual building blocks, e.g. security or safety. 
+_Nuestra aplicación debe ser capaz de poder generar preguntas de manera automática cuando el usuario lo solicite a través del juego. Las preguntas serán aleatorias, esto provocará Estas, deben estar almacenadas con su respuesta correcta correspondiente._
 
+=== _Modelo de dominio_
 
-.Form
-The form can be varied:
+_El modelo de dominio definirá las principales entidades o conceptos del juego, como "usuario", "pregunta", "partida", "respuesta", entre otros. Estas entidades formarán la base de la lógica del negocio y estarán presentes en múltiples aspectos del sistema, como la interfaz de usuario, la lógica de negocio y la persistencia de datos._
 
-* concept papers with any kind of structure
-* cross-cutting model excerpts or scenarios using notations of the architecture views
-* sample implementations, especially for technical concepts
-* reference to typical usage of standard frameworks (e.g. using Hibernate for object/relational mapping)
 
-.Structure
-A potential (but not mandatory) structure for this section could be:
+=== _Disponibilidad_
 
-* Domain concepts
-* User Experience concepts (UX)
-* Safety and security concepts
-* Architecture and design patterns
-* "Under-the-hood"
-* development concepts
-* operational concepts
+_La aplicación podrá ser desplegada desde la web por el usuario en cualquier momento, es decir, hay que crear una máquina servidor desde la cual se pueda desplegar el proyecto y así ser accesible en todo momento desde los exploradores web._
 
-Note: it might be difficult to assign individual concepts to one specific topic
-on this list.
+=== _Interfaz de usuario_
 
-image::08-Crosscutting-Concepts-Structure-EN.png["Possible topics for crosscutting concepts"]
+_La forma en que se presentan las preguntas y las posibles respuestas en la interfaz de usuario deben ser claras y legibles, con un diseño que facilite la comprensión rápida de la pregunta y las opciones de respuesta para el usuario. Además, la UI debe mostrar claramente el tiempo restante y proporcionar retroalimentación visual sobre el progreso del jugador, así como dejar claro donde esta cada apartado de la aplicación y donde poder ver las estadísticas, jugar...etc._
 
 
-.Further Information
+=== _Experiencia de usuario_
 
-See https://docs.arc42.org/section-8/[Concepts] in the arc42 documentation.
-****
-
-
-=== _<Concept 1>_
-
-_<explanation>_
-
-
-
-=== _<Concept 2>_
-
-_<explanation>_
-
-...
-
-=== _<Concept n>_
-
-_<explanation>_
+_La experiencia del usuario en la aplicación es una parte fundamental de una aplicación. Se debe intentar que los tiempos de respuesta sean mínimos, optimizando al máximo los recursos Wikidata. Además, los datos deben ser persistentes y los usuarios deben de poder crear y abrir sesión sin problemas; pudiendo, entre otras cosas, ver sus estadísitcas (histórico de juegos, preguntas acertadas y falladas... etc). Otros aspectos importantes como los colores, tamaños de letra o diseño también deben ser tenidos en cuenta para que la experiencia del usuario sea lo mejor posible._

docs/src/12_glossary.adoc

@@ -1,42 +1,31 @@
 ifndef::imagesdir[:imagesdir: ../images]
 
 [[section-glossary]]
-== Glossary
+== Glosario
 
-[role="arc42help"]
-****
-.Contents
-The most important domain and technical terms that your stakeholders use when discussing the system.
-
-You can also see the glossary as source for translations if you work in multi-language teams.
-
-.Motivation
-You should clearly define your terms, so that all stakeholders
-
-* have an identical understanding of these terms
-* do not use synonyms and homonyms
-
-
-.Form
-
-A table with columns <Term> and <Definition>.
+[cols="e,2e" options="header"]
+|===
+|Término |Definición
 
-Potentially more columns in case you need translations.
+|Wikidata
+|Base de datos colaborativa y libre que almacena datos estructurados de donde se obtiene la respuesta de las preguntas que se hacen en el juego.
 
+|MongoDB
+|MongoDB es una base de datos NoSQL orientada a documentos, en la cual se almacenarán los datos de la aplicación.
 
-.Further Information
+|API
+|Es un conjunto de reglas y protocolos que permite que distintos componentes de software se comuniquen entre sí. Las API definen los métodos y formatos de datos que deben seguirse para que las aplicaciones puedan interactuar de manera eficiente.
 
-See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
+|Frontend
+|Es la parte de un sistema o aplicación de software que interactúa directamente con los usuarios finales.
 
-****
+|Backend
+|Es la parte de un sistema o aplicación de software que no es visible para los usuarios finales y que se encarga de procesar datos, realizar cálculos y realizar funciones relacionadas con la lógica del negocio.
 
-[cols="e,2e" options="header"]
-|===
-|Term |Definition
+|Persistencia
+|Es el proceso de almacenamiento y recuperación de datos para mantener el estado de la aplicación.
 
-|<Term-1>
-|<definition-1>
+|Stakeholders
+|Son el conjunto de personas o entidades que tienen interés o influencia de alguna manera sobre un proyecto
 
-|<Term-2>
-|<definition-2>
-|===
+|===