Skip to content

Commit

Permalink
Añadido punto 12 documentacion y arreglos en el 5
Browse files Browse the repository at this point in the history
  • Loading branch information
uo282189 committed Feb 16, 2024
1 parent 3fbfc24 commit eb4e792
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 77 deletions.
73 changes: 1 addition & 72 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,13 @@ In the best case you will get away with examples or simple signatures.
****

_**<Overview Diagram>**_

Motivation::

The motivation for undertaking this decomposition is to gain a clear vision of the system developed for the WIQ application.
By breaking down the system into its constituent building blocks, we aim to establish a comprehensive understanding of its structure and functionality.


Contained Building Blocks::
_<Description of contained building block (black boxes)>_

User Interface (Frontend)

Expand All @@ -90,7 +87,6 @@ API Questions


Important Interfaces::
_<Description of important interfaces>_

[role="arc42help"]
****
Expand Down Expand Up @@ -133,25 +129,13 @@ Responsibility::

Provides the interface to register, play and check participation history

_<Interface(s)>_

_<(Optional) Quality/Performance Characteristics>_

_<(Optional) Directory/File Location>_

_<(Optional) Fulfilled Requirements>_

_<(optional) Open Issues/Problems/Risks>_

==== Business Logic

Responsibility::

Automatically generate questions and corresponding answers from Wikidata data.
Manages the time frame allocated for answering questions.

...

==== Database

Responsibility::
Expand All @@ -170,16 +154,6 @@ Responsibility::

The system will allow access to the information of the questions generated through an API.



==== <Name interface 1>

...

==== <Name interface m>



=== Level 2

[role="arc42help"]
Expand All @@ -200,63 +174,18 @@ image::05-UserInterface-Level2.png["Level 2 User Interface"]
...describes the internal structure of _building block 1_.
****

_<white box template>_

==== White Box Business Logic

image::05-BussinesLogic-Level2.png["Level 2 Business Logic"]


_<white box template>_


==== White Box Database

image::05-Database-Level2.png["Level 2 Database"]


_<white box template>_

==== White Box API User


_<white box template>_


==== White Box API Questions

_<white box template>_



=== Level 3

[role="arc42help"]
****
Here you can specify the inner structure of (some) building blocks from level 2 as white boxes.
When you need more detailed levels of your architecture please copy this
part of arc42 for additional levels.
****


==== White Box <_building block x.1_>

[role="arc42help"]
****
Specifies the internal structure of _building block x.1_.
****


_<white box template>_


==== White Box <_building block x.2_>

_<white box template>_



==== White Box <_building block y.1_>

_<white box template>_
==== White Box API Questions
20 changes: 15 additions & 5 deletions docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,19 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
|===
|Term |Definition

|<Term-1>
|<definition-1>

|<Term-2>
|<definition-2>
|Accessibility|Accessibility is the practice of designing products, devices, services, or environments to be usable by people with disabilities. It aims to ensure that everyone, regardless of their physical or cognitive abilities, can perceive, understand, navigate, and interact with digital or physical environments effectively and without barriers.
|API|An API (Application Programming Interface) is a set of rules, protocols, and tools that enables different software applications to communicate and interact with each other. It defines the methods and data formats that applications can use to request and exchange information, allowing for seamless integration and interoperability between systems, services, and platforms.
|Back end|The back end is the part of a web application that operates behind the scenes and is responsible for managing and processing data, as well as handling requests from the front end. It includes the server, application logic, and database.
|Database|Database is a structured collection of data that is organized in a way that allows for efficient storage, retrieval, manipulation, and management. They facilitate data organization, retrieval, and analysis, enabling businesses to make informed decisions, support transactional operations, and deliver valuable services to users.
|Docker|Docker is a platform that simplifies the process of developing, deploying, and running applications by utilizing containerization technology.
|Front end|Front end is the part of a web application that users interact with directly. It encompasses everything that users see, touch, and interact with in their web browsers. This includes the user interface (UI), design elements, layouts, content, and interactive features.
|GitHub|GitHub is a web-based platform and version control system that facilitates collaboration and software development workflows.
|JavaScript|JavaScript is a programming language primarily employed for web development. It enables developers to add interactivity, dynamic behavior, and client-side scripting to web pages.
|JSON|Stands for JavaScript Object Notation. It's a lightweight data interchange format that is easy for humans to read and write and easy for machines to parse and generate.
|MongoDB|MongoDB is a NoSQL database that stores data in a flexible, document-oriented format called BSON (Binary JSON). It is designed for scalability, high performance, and ease of development.
|Node.js|Node.js is a server-side runtime environment that allows developers to run JavaScript code outside of a web browser.
|Performance|Performance refers to the responsiveness, speed, and efficiency of a system or application in executing tasks and handling user interactions. It encompasses factors such as response time, throughput, resource consumption, and scalability, all of which contribute to a satisfactory user experience.
|React|React is a JavaScript library for building interactive and dynamic user interfaces.
|Usability|Usability refers to the extent to which a product or system can be used by specified users to achieve specified goals with effectiveness, efficiency, and satisfaction. It focuses on enhancing the user experience by ensuring that interfaces are intuitive, tasks are easy to accomplish, and interactions are pleasant.
|Wikidata|Wikidata is an open knowledge base. It serves as a centralized repository for structured data.
|===

0 comments on commit eb4e792

Please sign in to comment.