Skip to content

Commit

Permalink
Doc lara
Browse files Browse the repository at this point in the history
  • Loading branch information
uo276026 committed Feb 22, 2024
1 parent 52bd539 commit 40a1da5
Show file tree
Hide file tree
Showing 7 changed files with 57 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
// configure EN settings for asciidoc
include::src/config.adoc[]

= image:arc42-logo.png[arc42] Template
= image:arc42-logo.png[arc42] Documentación wiq_es05a
:revnumber: 8.2 EN
:revdate: January 2023
:revremark: (based upon AsciiDoc version)
// toc-title definition MUST follow document title without blank line!
:toc: left
:toc-title: Table of Contents

//additional style for arc42 help callouts
Expand Down
1 change: 1 addition & 0 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion docs/src/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,9 @@ A table with quality goals and concrete scenarios, ordered by priorities
|===
|Nombre|Descripción
|Usabilidad| La aplicación tiene que poder usarse por un publico diverso
|Privacidad| Los datos de los usuarios tienen que ser privados
|Rendimiento| El tiempo de respuesta de la aplicación debe ser rápido
|Testeable| La aplicación debe probarse con cada actualización
|Disponibilidad| La aplicación debe estar disponible y caerse lo menos posible
|===
=== Stakeholders

Expand Down
2 changes: 1 addition & 1 deletion docs/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,5 @@ a través de nuestro grupo de WhatsApp y en casos necesarios realizamos reunione
|_Para crearla usaremos la plantilla Arc42 con la finalidad de que sea sencilla y práctica._

|*Accesibilidad*
|_Nuestro aplicación puede ser utilizada por cualquier tipo de usuario hispanohablante, sin importar quien sea, ya que será fácil de entender e interactuar._
|_Nuestro aplicación puede ser utilizada por cualquier tipo de usuario, sin importar quien sea, ya que será fácil de entender e interactuar._
|===
19 changes: 19 additions & 0 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,25 @@ The title of the table is the name of your system, the three columns contain the

image::03_1_contexto-negocio.png["Diagrama de contexto de negocio"]

[cols="e,2e" options="header"]
|===
|Componentes |Explicación

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

|*MongoDB*
|_Base de datos para almacenar la información de los usuarios._

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

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

|===


=== Contexto Técnico

[role="arc42help"]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ See https://docs.arc42.org/section-4/[Solution Strategy] in the arc42 documentat

* *Firebase*: Esta API nos servirá como sistema de autenticación del usuario para poder llevar un registro de su historial de partidas, así como algunas de sus estadísticas.

* *WikiData*: Se trata de otra API a partir de la cual se generarán aleatoriamente las preguntas y respuestas, tanto correctas como incorrectas, que el usuario visualizará.

* *Microservicios:* Enfoque arquitectónico donde el software está compuesto por pequeños servicios independientes. Lo hemos elegido por encima de MVC, por la facilidad a la hora de modificar una parte de la aplicación sin afectar al resto.

* *MongoDB:* Es una base de datos NoSQL sencilla de utilizar y que ya conocemos.
30 changes: 30 additions & 0 deletions docs/src/09_architecture_decisions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,33 @@ See https://docs.arc42.org/section-9/[Architecture Decisions] in the arc42 docum
There you will find links and examples about ADR.
****

[options="header",cols="1,2,1,2,2"]
|===
|Aspecto |Descripción |Decisión |Explicación |Alternativas

|*Lenguaje de Programación*
|_Lenguaje en el que se desarrollara la aplicación._
|*JavaScript*
|_Nos ha parecido la mejor opción; ya que es el más recomendable para utilizar en proyectos con REACT; y su comprensión y manejo es sencillo._
|*TypeScript*, _pero creemos que es mas complejo._

|*Framework*
|_Marco de trabajo para desarrollar la parte grafica de la aplicación._
|*React*
|_Hemos elegido este framework ya que simplifica la creación de interfaces gráficas._
|*Angular*.

|*Base de Datos*
|_Donde almacenaremos la informacion de los usuarios._
|*MongoDB*
|_La hemos elegido porque es una base de datos NoSQL fácil de usar que ya conocemos._
|*MySQL*

|*Arquitectura*
|_La forma en la que se estructura la aplicación._
|*Microservicios*
|_Es una forma sencilla de estructurar; facil de desacoplar y reutilizar._
|_Simplemente basada en_ *front-end y back-end*

|===

0 comments on commit 40a1da5

Please sign in to comment.