diff --git a/docs/images/businesscontext.png b/docs/images/businesscontext.png deleted file mode 100644 index 1609bb98..00000000 Binary files a/docs/images/businesscontext.png and /dev/null differ diff --git a/docs/images/businesscontext.svg b/docs/images/businesscontext.svg new file mode 100644 index 00000000..18ddb206 --- /dev/null +++ b/docs/images/businesscontext.svg @@ -0,0 +1,29 @@ +User«system»WIQ!«extern»Wikidataplaysasks questionsrequest data to generate questionsreturns data \ No newline at end of file diff --git a/docs/images/technicalcontext.png b/docs/images/technicalcontext.png deleted file mode 100644 index 3f41aa63..00000000 Binary files a/docs/images/technicalcontext.png and /dev/null differ diff --git a/docs/images/technicalcontext.svg b/docs/images/technicalcontext.svg new file mode 100644 index 00000000..21e5dec1 --- /dev/null +++ b/docs/images/technicalcontext.svg @@ -0,0 +1,50 @@ +DeviceAzureBrowserWIQ!MongoDBUserAdminWikidatainteractsusesSSHHTTP/HTTPSaccessesREST \ No newline at end of file diff --git a/docs/index.adoc b/docs/index.adoc index 468be5fd..38006e65 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -6,7 +6,7 @@ // configure EN settings for asciidoc include::src/config.adoc[] -= image:arc42-logo.png[arc42] Template += image:arc42-logo.png[arc42] WIQ! Documentation :revnumber: 8.2 EN :revdate: January 2023 :revremark: (based upon AsciiDoc version) diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc index 5c1f62d8..b4e0acc0 100644 --- a/docs/src/01_introduction_and_goals.adoc +++ b/docs/src/01_introduction_and_goals.adoc @@ -50,8 +50,8 @@ WIQ! is a software by means of which users can emulate being the participants of | The application must have a well-defined and structured design, so that it is easy to make modifications and/or extensions. | *3* -| *_Privacy_* -| The application must guarantee the privacy of its users' information, with mechanisms in place to prevent intrusions into the system. +| *_Availability_* +| The application must ensure high availability, with mechanisms in place to prevent system failures and ensure continuous access to its services. |=== === Stakeholders diff --git a/docs/src/02_architecture_constraints.adoc b/docs/src/02_architecture_constraints.adoc index de6edc58..96e90792 100644 --- a/docs/src/02_architecture_constraints.adoc +++ b/docs/src/02_architecture_constraints.adoc @@ -6,20 +6,16 @@ ifndef::imagesdir[:imagesdir: ../images] |=== | *_Architecture constraint_* | *_Description_* -| *_Tecnología de Desarrollo_* | The application must be developed using web technologies compatible with RTVE's requirements and standards. +| *_Development Technology_* | The application must be developed using web technologies compatible with RTVE's requirements and standards. -| *_Plataforma de Implementación_* | The application must be implemented on a web hosting platform that meets RTVE's performance, security and scalability requirements. +| *_Implementation Platform_* | The application must be implemented on a web hosting platform that meets RTVE's performance, security and scalability requirements. -| *_Cumplimiento de Normativas de Privacidad_* | The architecture must ensure compliance with data privacy regulations, such as GDPR, to protect users' information. +| *_Privacy Compliance_* | The architecture must ensure compliance with data privacy regulations, such as GDPR, to protect users' information. -| *_Compatibilidad con Navegadores_* | The application should be compatible with a wide range of popular web browsers to ensure a consistent user experience. +| *_Code Maintainability_* | Software development practices that promote clean and well-documented code should be followed to facilitate future upgrades and maintenance. -| *_Seguridad de la Información_* | Strong security measures, such as user authentication, access control and data encryption, must be implemented to protect users' confidential information. - -| *_Escalabilidad_* | The architecture must be scalable to handle increased user traffic without compromising performance. - -| *_Mantenibilidad del Código_* | Software development practices that promote clean and well-documented code should be followed to facilitate future upgrades and maintenance. - -| *_Tiempo de Desarrollo_* | The application must be developed within a specific time frame, which may influence architectural decisions and technology selection. +| *_Development Time_* | The application must be developed within a specific time frame, which may influence architectural decisions and technology selection. +| *_Wikidata Integration_* +| The system architecture must incorporate the use of Wikidata as data source to generate questions, ensuring seamless integration and consistency with external knowledge bases. |=== diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc index af83295e..c8b3ebff 100644 --- a/docs/src/03_system_scope_and_context.adoc +++ b/docs/src/03_system_scope_and_context.adoc @@ -4,7 +4,23 @@ ifndef::imagesdir[:imagesdir: ../images] == System Scope and Context === Business Context -image::businesscontext.png[Business context] +image::businesscontext.svg[Business context] + +|=== +| *Entity* | *_Description_* +| *_User_* | It's the one that interacts directly with the app. +| *_WIQ!_* | The web application. +| *_Wikidata_* | Source from which data is drawn to formulate questions +|=== === Technical Context -image::technicalcontext.png[Technical Context] +image::technicalcontext.svg[Technical Context] +|=== +| *Entity* | *_Description_* +| *_User_* | Represents the user interacting with the system. In this case, the user is interacting with the "WIQ!" application through the device and the web browser. +| *_Device_* | The device used by the user to access the application. This node contains the web browser component that allows the user to interact with the application. +| *_Cloud_* | Represents the cloud infrastructure, in this case, Azure. This node contains the "WIQ!" component that hosts the application and allows its access through HTTP/HTTPS protocols. +| *_WIQ!_* | The main application that the user interacts with. It is hosted on the Azure cloud and accesses a MongoDB database to store and retrieve data, as well as interacts with Wikidata through REST. +| *_Wikidata_* | Source from which data is drawn to formulate questions. The application will request data via "Wikidata Query Service", which allows to retrieve data using SparQL. +| *_MongoDB_* | The database management system used by the "WIQ!" application to store and retrieve data. In this case, it is used to store data related to the application. +|=== \ No newline at end of file