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

Update 03_system_scope_and_context.adoc #19

Merged
merged 1 commit into from
Feb 11, 2024
Merged
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
76 changes: 31 additions & 45 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
@@ -1,75 +1,61 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-system-scope-and-context]]
== System Scope and Context
== Alcance y contexto del sistema



[role="arc42help"]
****
.Contents
System scope and context - as the name suggests - delimits your system (i.e. your scope) from all its communication partners
(neighboring systems and users, i.e. the context of your system). It thereby specifies the external interfaces.

If necessary, differentiate the business context (domain specific inputs and outputs) from the technical context (channels, protocols, hardware).

.Motivation
The domain interfaces and technical interfaces to communication partners are among your system's most critical aspects. Make sure that you completely understand them.

.Form
Various options:

* Context diagrams
* Lists of communication partners and their interfaces.


.Further Information
Nuestro proyecto, denominado "WIQ", consiste en una simulación inspirada en el famoso juego de RTVE "Saber y Ganar" (más información en: https://www.rtve.es/play/videos/saber-y-ganar/), en el cual los concursantes tienen la oportunidad de hacerse con una cantidad de dinero en función del número de respuestas acertadas a preguntas de diversas temáticas, con un límite establecido de tiempo para cada una de ellas.

See https://docs.arc42.org/section-3/[Context and Scope] in the arc42 documentation.
La aplicación permitirá a los usuarios no solo acumular dinero al participar en la funcionalidad básica de juego de preguntas y respuestas, si no que cuenta también con otras funcionalidades como poder consultar su historial de juegos y el listado completo de usuarios registrados.

****


=== Business Context
=== Contexto de negocio

[role="arc42help"]
****
.Contents
Specification of *all* communication partners (users, IT-systems, ...) with explanations of domain specific inputs and outputs or interfaces.
Optionally you can add domain specific formats or communication protocols.
Al acceder a la página principal de la aplicación, los usuarios podrán ver una interfaz que les permitirá iniciar sesión para acceder a su cuenta. En caso de ser su primera vez y no tener cuenta, tendrá la opción de registrarse. Una vez autenticados, los usuarios se encontrarán con la opción tanto empezar un nuevo juego como de ver su historial
de jugadas anteriores.

.Motivation
All stakeholders should understand which data are exchanged with the environment of the system.
Dentro del historial, este le mostrará el número de partidas totales realizadas y por cada una de ellas el número de respuestas acertadas, el dinero conseguido y el tiempo total
que le llevó completarlo.

.Form
All kinds of diagrams that show the system as a black box and specify the domain interfaces to communication partners.

Alternatively (or additionally) you can use a table.
The title of the table is the name of your system, the three columns contain the name of the communication partner, the inputs, and the outputs.
Aparte de eso también tendrán la opción de visualizar el listado completo de usuarios registrados hasta la fecha.

****

**<Diagram or Table>**

**<optionally: Explanation of external domain interfaces>**

=== Technical Context
=== Contexto técnico

[role="arc42help"]
****
.Contents
Technical interfaces (channels and transmission media) linking your system to its environment. In addition a mapping of domain specific input/output to the channels, i.e. an explanation which I/O uses which channel.
Para el desarrollo de este proyecto usaremos la API de Wikidata tanto para generar automaticamente las preguntas como para obtener
las respuestas correctas a las mismas.
Respecto al lenguaje de programación se usará JavaScript, utilizando React para el desarrollo del front-end. Además
haremos uso de Node.js y la implementación de microservicios para el back-end. Respecto a la base de datos usaremos una NonSQL como MongoDB.

.Motivation
Many stakeholders make architectural decision based on the technical interfaces between the system and its context. Especially infrastructure or hardware designers decide these technical interfaces.
|===
| Interfaz técnica | Explicación

.Form
E.g. UML deployment diagram describing channels to neighboring systems,
together with a mapping table showing the relationships between channels and input/output.
| Wikidata
| API usada para generar automáticamente las preguntas y obtener su respuesta.

****
| JavaScript
| Lenguaje principal de la aplicación.

**<Diagram or Table>**
| React
| Librería JavaScript que nos permitirá construir la interfaz de la aplicación.

**<optionally: Explanation of technical interfaces>**
| MongoDB
| Base de datos NoSQL.

| Node.Js
| Entorno de servidor para tratar los endpoints.
|===

****

**<Mapping Input/Output to Channels>**