Skip to content

Commit

Permalink
Apartado 3 de la documentación V0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
marcosMachadoMenendez committed Feb 18, 2024
1 parent 924480b commit d7b2ee9
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 58 deletions.
Binary file added docs/images/diag_contexto_business.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/diag_contexto_tecnico.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
85 changes: 27 additions & 58 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
@@ -1,75 +1,44 @@
ifndef::imagesdir[:imagesdir: ../images]

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


[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.
=== Contexto de negocio

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.
image::diag_contexto_business.png["Diagrama de contexto de negocio"]

.Form
Various options:
[cols="1,1"]
|===
|Actor |Descripción

* Context diagrams
* Lists of communication partners and their interfaces.
|Usuario
|Los usuarios interactuan con el sistema viendo y respondiendo preguntas

|Wikidata
|Las preguntas y sus respuestas se obtienen de wikidata
|===

.Further Information
=== Contexto técnico

See https://docs.arc42.org/section-3/[Context and Scope] in the arc42 documentation.

****
image::diag_contexto_tecnico.png["Diagrama de contexto técnico"]

[cols="1,1,1"]
|===
|Interfaz |Descripción |I/O

=== Business Context
|Usuario
|Los usuarios interactuan con el WebApp del sistema viendo y respondiendo preguntas
|Salida: acciones del usuario

[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.
|Azure
|La WebApp del sistema se despliega en Azure y muestra a los usuarios información obtenida de la API de Wikidata
|Entrada: acciones del usuario y datos de preguntas +
Salida: preguntas y respuestas generadas automáticamente

.Motivation
All stakeholders should understand which data are exchanged with the environment of the system.
.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.
****

**<Diagram or Table>**

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

=== Technical Context

[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.
.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.
.Form
E.g. UML deployment diagram describing channels to neighboring systems,
together with a mapping table showing the relationships between channels and input/output.
****

**<Diagram or Table>**

**<optionally: Explanation of technical interfaces>**

**<Mapping Input/Output to Channels>**
|Wikidata
|El sistema llama a la API REST de wikidata para obtener los datos de las preguntas y respuestas que se generarán automáticamente
|Salida: datos de preguntas
|===

0 comments on commit d7b2ee9

Please sign in to comment.