From 18d6213a70fec3175f2cd3559e6abf384ad2dd60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ricardo=20D=C3=ADaz=20N=C3=BA=C3=B1ez?= <113308231+RicardoDiNu@users.noreply.github.com> Date: Sun, 18 Feb 2024 01:53:34 +0100 Subject: [PATCH] Translate Doc 5 and 6 (#39) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Pelayo Rojas Íñigo <31128562+Pelayori@users.noreply.github.com> --- docs/src/05_building_block_view.adoc | 16 ++-- docs/src/06_runtime_view.adoc | 126 +++++++++++++-------------- 2 files changed, 71 insertions(+), 71 deletions(-) diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc index f08d36db..f1d8c553 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -78,25 +78,25 @@ rectangle "Wikidata" { Motivation:: -El propósito de esta whitebox es proporcionar una visión clara, sencilla y sin entrar en detalles de cómo el sistema WIQ interactúa con el servicio -externo de Wikidata para obtener los datos necesarios para generar preguntas. Al presentar esta interacción de manera clara, -los stakeholders pueden comprender fácilmente cómo se integra el sistema WIQ con fuentes externas de datos y cómo se utiliza esa -información para cumplir con los requisitos del sistema relacionados con la generación automática de preguntas. +The purpose of this whitebox is to provide a clear, simple overview without delving into details of how the WIQ system interacts +with the external Wikidata service to obtain the necessary data for question generation. By presenting this interaction clearly, +stakeholders can easily understand how the WIQ system integrates with external data sources and how that information is used to +fulfill system requirements related to the automatic generation of questions. Contained Building Blocks:: [cols="e,2e" options="header"] |=== -| Nombre | Descripción +| Name | Description | User -| Representa al usuario que interactúa con la aplicación WIQ. +| It represents the user interacting with the WIQ application. | WIQ -| Representa la aplicación principal WIQ. +| It represents the main WIQ application. | Wikidata -| Servicio externo utilizado por WIQ para obtener datos y generar preguntas. +| External service used by WIQ to obtain data and generate questions. |=== diff --git a/docs/src/06_runtime_view.adoc b/docs/src/06_runtime_view.adoc index 3c7a30b8..e23b92f3 100644 --- a/docs/src/06_runtime_view.adoc +++ b/docs/src/06_runtime_view.adoc @@ -37,104 +37,104 @@ See https://docs.arc42.org/section-6/[Runtime View] in the arc42 documentation. **** -=== Autenticación del usuario +=== User Authentication [plantuml,"Sequence diagram 1",png] ---- -actor Usuario +actor User participant "WIQ Frontend" as Frontend participant "WIQ Backend" as Backend -database BaseDeDatos as Data - -Usuario -> Frontend: Iniciar sesión -Frontend -> Backend: Petición de autenticación -Backend -> Data: Consulta de datos de usuario -Data --> Backend: Datos de usuario -Backend --> Frontend: Respuesta de autenticación -Frontend --> Usuario: Confirmación de inicio de sesión +database Database as Data + +User -> Frontend: Log in +Frontend -> Backend: Authentication request +Backend -> Data: User data query +Data --> Backend: User data +Backend --> Frontend: Authentication response +Frontend --> User: Login confirmation ---- -=== Generación de una pregunta +=== Question Generation [plantuml,"Sequence diagram 2",png] ---- -actor Usuario +actor User participant "WIQ Frontend" as Frontend participant "WIQ Backend" as Backend -database BaseDeDatos as DB +database Database as DB database Wikidata as Data -Usuario -> Frontend: Solicita generación de pregunta -Frontend -> Backend: Petición de generación de pregunta -Backend -> DB: Consulta de datos relevantes en BD -DB --> Backend: Datos obtenidos de BD -Backend -> Data: Consulta de datos relevantes en Wikidata -Data --> Backend: Datos obtenidos de Wikidata -Backend -> Backend: Generación de pregunta y respuestas -Backend --> Frontend: Pregunta generada +User -> Frontend: Request question generation +Frontend -> Backend: Question generation request +Backend -> DB: Relevant data query in DB +DB --> Backend: Data obtained from DB +Backend -> Data: Relevant data query in Wikidata +Data --> Backend: Data obtained from Wikidata +Backend -> Backend: Question and answers generation +Backend --> Frontend: Generated question ---- -=== Usuario responde una pregunta +=== User Responds to a Question [plantuml,"Sequence diagram 3",png] ---- -actor Usuario +actor User participant "WIQ Frontend" as Frontend participant "WIQ Backend" as Backend -database BaseDeDatos as Data - -Usuario -> Frontend: Responder pregunta -Frontend -> Backend: Enviar respuesta -Backend -> Data: Consulta de datos de la pregunta -Data --> Backend: Datos de la pregunta -Backend -> Backend: Evaluar respuesta -Backend --> Frontend: Resultado de la respuesta +database Database as Data + +User -> Frontend: Answer question +Frontend -> Backend: Send answer +Backend -> Data: Question data query +Data --> Backend: Question data +Backend -> Backend: Evaluate answer +Backend --> Frontend: Answer result ---- -=== Usuario consulta su historial +=== User Checks their History [plantuml,"Sequence diagram 4",png] ---- -actor Usuario +actor User participant "WIQ Frontend" as Frontend participant "WIQ Backend" as Backend -database BaseDeDatos as DB +database Database as DB -Usuario -> Frontend: Consultar historial -Frontend -> Backend: Petición de historial -Backend -> DB: Consulta de historial del usuario -DB --> Backend: Datos del historial -Backend --> Frontend: Historial del usuario +User -> Frontend: Check history +Frontend -> Backend: History request +Backend -> DB: User history query +DB --> Backend: History data +Backend --> Frontend: User history ---- -=== Acceso a la información de los usuarios a través de un API +=== Access to User Information via an API [plantuml,"Sequence diagram 5",png] ---- -actor Usuario +actor User participant "WIQ Frontend" as Frontend participant "WIQ Backend" as Backend -database BaseDeDatos as DB -participant "API de Usuarios" as UserAPI - -Usuario -> Frontend: Acceder a información de usuario -Frontend -> Backend: Petición de información de usuario -Backend -> DB: Consulta de datos del usuario -DB --> Backend: Datos del usuario -Backend -> UserAPI: Consulta de información del usuario -UserAPI --> Backend: Datos del usuario a través del API -Backend --> Frontend: Datos del usuario +database Database as DB +participant "User API" as UserAPI + +User -> Frontend: Access user information +Frontend -> Backend: User information request +Backend -> DB: User data query +DB --> Backend: User data +Backend -> UserAPI: User information query +UserAPI --> Backend: User data via API +Backend --> Frontend: User data ---- -=== Acceso a la información de las preguntas generadas a través de un API +=== Access to Generated Questions Information via an API [plantuml,"Sequence diagram 6",png] ---- -actor Usuario +actor User participant "WIQ Frontend" as Frontend participant "WIQ Backend" as Backend -database BaseDeDatos as DB -participant "API de Preguntas" as QuestionAPI - -Usuario -> Frontend: Acceder a información de preguntas -Frontend -> Backend: Petición de información de preguntas -Backend -> DB: Consulta de datos de preguntas -DB --> Backend: Datos de las preguntas -Backend -> QuestionAPI: Consulta de información de preguntas -QuestionAPI --> Backend: Datos de las preguntas a través del API -Backend --> Frontend: Datos de las preguntas +database Database as DB +participant "Question API" as QuestionAPI + +User -> Frontend: Access question information +Frontend -> Backend: Question information request +Backend -> DB: Questions data query +DB --> Backend: Questions data +Backend -> QuestionAPI: Questions information query +QuestionAPI --> Backend: Questions data via API +Backend --> Frontend: Questions data ----