Skip to content

Commit

Permalink
Mejoras de aspecto en la documentación
Browse files Browse the repository at this point in the history
  • Loading branch information
uo276026 committed Feb 22, 2024
1 parent dc670ff commit 54ed08c
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 25 deletions.
9 changes: 5 additions & 4 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,9 @@ ifdef::backend-html5[]
endif::backend-html5[]


include::src/about-arc42.adoc[]

// horizontal line
***



[role="arc42help"]
****
Expand Down Expand Up @@ -97,4 +96,6 @@ include::src/11_technical_risks.adoc[]
// 12. Glossary
include::src/12_glossary.adoc[]


// horizontal line
***
include::src/about-arc42.adoc[]
23 changes: 12 additions & 11 deletions docs/src/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,13 @@ If you as an architect do not know how the quality of your work will be judged..
.Form
A table with quality goals and concrete scenarios, ordered by priorities
****
[cols="e,2e" options="header"]
|===
|Nombre|Descripción
|Usabilidad| La aplicación tiene que poder usarse por un publico diverso
|Rendimiento| El tiempo de respuesta de la aplicación debe ser rápido
|Testeable| La aplicación debe probarse con cada actualización
|Disponibilidad| La aplicación debe estar disponible y caerse lo menos posible
|*Usabilidad*| _La aplicación tiene que poder usarse por un publico diverso_
|*Rendimiento*| _El tiempo de respuesta de la aplicación debe ser rápido_
|*Testeable*| _La aplicación debe probarse con cada actualización_
|*Disponibilidad*| _La aplicación debe estar disponible y caerse lo menos posible_
|===
=== Stakeholders

Expand All @@ -100,13 +101,13 @@ These stakeholders determine the extent and the level of detail of your work and
Table with role names, person names, and their expectations with respect to the architecture and its documentation.
****

[options="header",cols="1,2,2"]
[cols="e,2e,2e" options="header"]
|===
|Rol/Nombre|Expectativa|Descripción
| Cristian Augusto | Una buena aplicación | Profesor de la asignatura
| HappySw | Una aplicación buena para atraer al mayor número de usuarios | Equipo de desarrollo
| Wikidata | Un buen uso de su aplicación | Empresa que nos facilita la API para obtener información
| Usuarios Registrados | Una buena aplicación | Los usuarios de la aplicación
| Usuarios No Registrados | Una buena aplicación | Los usuarios de la aplicación
| RTVE | Una buena versión de su juego "Saber y Ganar" | Empresa contratista, el cliente
| *Cristian Augusto* | _Una buena aplicación_ | _Profesor de la asignatura_
| *HappySw* | _Una aplicación buena para atraer al mayor número de usuarios_ | _Equipo de desarrollo_
| *Wikidata* | _Un buen uso de su aplicación_ | _Empresa que nos facilita la API para obtener información_
| *Usuarios Registrados* | _Una buena aplicación_ | _Los usuarios de la aplicación_
| *Usuarios No Registrados* | _Una buena aplicación_ | _Los usuarios de la aplicación_
| *RTVE* | _Una buena versión de su juego "Saber y Ganar"_ | _Empresa contratista, el cliente_
|===
2 changes: 1 addition & 1 deletion docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-solution-strategy]]
== Solution Strategy
== Estrategia de solución


[role="arc42help"]
Expand Down
12 changes: 6 additions & 6 deletions docs/src/09_architecture_decisions.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-design-decisions]]
== Architecture Decisions
== Decisiones arquitectónicas


[role="arc42help"]
Expand Down Expand Up @@ -34,32 +34,32 @@ There you will find links and examples about ADR.
****

[options="header",cols="1,2,1,2,2"]
[options="header",cols="1,2,1,2,2e"]
|===
|Aspecto |Descripción |Decisión |Explicación |Alternativas

|*Lenguaje de Programación*
|_Lenguaje en el que se desarrollara la aplicación._
|*JavaScript*
|_Nos ha parecido la mejor opción; ya que es el más recomendable para utilizar en proyectos con REACT; y su comprensión y manejo es sencillo._
|*TypeScript*, _pero creemos que es mas complejo._
|*TypeScript*, pero creemos que es mas complejo.

|*Framework*
|_Marco de trabajo para desarrollar la parte grafica de la aplicación._
|*React*
|_Hemos elegido este framework ya que simplifica la creación de interfaces gráficas._
|*Angular*.
|*Angular.*

|*Base de Datos*
|_Donde almacenaremos la informacion de los usuarios._
|*MongoDB*
|_La hemos elegido porque es una base de datos NoSQL fácil de usar que ya conocemos._
|*MySQL*
|*MySQL.*

|*Arquitectura*
|_La forma en la que se estructura la aplicación._
|*Microservicios*
|_Es una forma sencilla de estructurar; facil de desacoplar y reutilizar._
|_Simplemente basada en_ *front-end y back-end*
|Simplemente basada en *front-end y back-end.*

|===
6 changes: 3 additions & 3 deletions docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-glossary]]
== Glossary
== Glosario

[role="arc42help"]
****
Expand Down Expand Up @@ -30,9 +30,9 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
****

[cols="e,2e" options="header"]
[cols="e,2" options="header"]
|===
|Term |Definition
|Término |Definición

|*API*
|Interfaz de programación de aplicaciones que permite la comunicación entre diferentes programas de software.
Expand Down

0 comments on commit 54ed08c

Please sign in to comment.