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

Documentación punto 5 #44

Merged
merged 1 commit into from
Feb 26, 2024
Merged
Show file tree
Hide file tree
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
Binary file added docs/images/05_nivel_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/05_sistema-general-caja-blanca.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
161 changes: 32 additions & 129 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ifndef::imagesdir[:imagesdir: ../images]
[[section-building-block-view]]


== Building Block View
== Vista de Bloques

[role="arc42help"]
****
Expand Down Expand Up @@ -40,7 +40,7 @@ See https://docs.arc42.org/section-5/[Building Block View] in the arc42 document

****

=== Whitebox Overall System
=== Nivel 1: Sistema General de Caja Blanca

[role="arc42help"]
****
Expand All @@ -63,150 +63,53 @@ In the best case you will get away with examples or simple signatures.

****

_**<Overview Diagram>**_
image::05_sistema-general-caja-blanca.png["Sistema General de Caja Blanca"]

Motivation::

_<text explanation>_
Motivación::


Contained Building Blocks::
_<Description of contained building block (black boxes)>_
La motivación de este diagrama es ofrecer una representación clara y sencilla de cómo el sistema interactúa con los usuarios y los servicios externos.

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

[role="arc42help"]
****
Insert your explanations of black boxes from level 1:

If you use tabular form you will only describe your black boxes with name and
responsibility according to the following schema:

[cols="1,2" options="header"]
|===
| **Name** | **Responsibility**
| _<black box 1>_ | _<Text>_
| _<black box 2>_ | _<Text>_
Bloques de construcción contenidos::
[cols="e,2e" options="header"]
|===
|Nombre |Responsabilidad

|*Usuario*
|_Usuario que interactua con la aplicación._

|*Administrador*
|_Persona(s) que tienen acceso completo a la aplicación y puede administrarla._

If you use a list of black box descriptions then you fill in a separate black box template for every important building block .
Its headline is the name of the black box.
****


==== <Name black box 1>

[role="arc42help"]
****
Here you describe <black box 1>
according the the following black box template:

* Purpose/Responsibility
* Interface(s), when they are not extracted as separate paragraphs. This interfaces may include qualities and performance characteristics.
* (Optional) Quality-/Performance characteristics of the black box, e.g.availability, run time behavior, ....
* (Optional) directory/file location
* (Optional) Fulfilled requirements (if you need traceability to requirements).
* (Optional) Open issues/problems/risks

****

_<Purpose/Responsibility>_

_<Interface(s)>_

_<(Optional) Quality/Performance Characteristics>_

_<(Optional) Directory/File Location>_

_<(Optional) Fulfilled Requirements>_

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




==== <Name black box 2>

_<black box template>_

==== <Name black box n>

_<black box template>_


==== <Name interface 1>

...

==== <Name interface m>



=== Level 2
|*WIQ*
|_La propia aplicación._

[role="arc42help"]
****
Here you can specify the inner structure of (some) building blocks from level 1 as white boxes.

You have to decide which building blocks of your system are important enough to justify such a detailed description.
Please prefer relevance over completeness. Specify important, surprising, risky, complex or volatile building blocks.
Leave out normal, simple, boring or standardized parts of your system
****

==== White Box _<building block 1>_

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

_<white box template>_

==== White Box _<building block 2>_


_<white box template>_

...

==== White Box _<building block m>_


_<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_.
****
|*Wikidata*
|_Servicio externo desde donde obtenemos los datos para generar las preguntas._

|*Firebase*
|_Plataforma para el manejo de sesiones de los usuarios, asi como informacion sobre sus estadisticas._
|===

_<white box template>_
=== Nivel 2: WIQ

image::05_nivel_2.png["Nivel 2 de la aplicación: WIQ"]

==== White Box <_building block x.2_>
Bloques de construcción contenidos::
[cols="e,2e" options="header"]
|===
|Nombre |Responsabilidad

_<white box template>_
|*Webapp*
|_La interfaz con la que interactua el usuario._

|*REST*
|_Manejo de datos de Wikidata._

|*Users*
|_El manejo de las cuentas de los usuarios._
|===

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

_<white box template>_
Loading