From 54ed08c11c01483b936707fd53efd1b4d1bbedc6 Mon Sep 17 00:00:00 2001 From: Lara Date: Thu, 22 Feb 2024 14:41:38 +0100 Subject: [PATCH] =?UTF-8?q?Mejoras=20de=20aspecto=20en=20la=20documentaci?= =?UTF-8?q?=C3=B3n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/index.adoc | 9 +++++---- docs/src/01_introduction_and_goals.adoc | 23 ++++++++++++----------- docs/src/04_solution_strategy.adoc | 2 +- docs/src/09_architecture_decisions.adoc | 12 ++++++------ docs/src/12_glossary.adoc | 6 +++--- 5 files changed, 27 insertions(+), 25 deletions(-) diff --git a/docs/index.adoc b/docs/index.adoc index 3d47546..8994089 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -30,10 +30,9 @@ ifdef::backend-html5[] endif::backend-html5[] -include::src/about-arc42.adoc[] -// horizontal line -*** + + [role="arc42help"] **** @@ -97,4 +96,6 @@ include::src/11_technical_risks.adoc[] // 12. Glossary include::src/12_glossary.adoc[] - +// horizontal line +*** +include::src/about-arc42.adoc[] \ No newline at end of file diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc index 01c6426..3535170 100644 --- a/docs/src/01_introduction_and_goals.adoc +++ b/docs/src/01_introduction_and_goals.adoc @@ -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 @@ -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_ |=== diff --git a/docs/src/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc index 8d1afd4..394a729 100644 --- a/docs/src/04_solution_strategy.adoc +++ b/docs/src/04_solution_strategy.adoc @@ -1,7 +1,7 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-solution-strategy]] -== Solution Strategy +== Estrategia de solución [role="arc42help"] diff --git a/docs/src/09_architecture_decisions.adoc b/docs/src/09_architecture_decisions.adoc index 9cf3d03..54a06d9 100644 --- a/docs/src/09_architecture_decisions.adoc +++ b/docs/src/09_architecture_decisions.adoc @@ -1,7 +1,7 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-design-decisions]] -== Architecture Decisions +== Decisiones arquitectónicas [role="arc42help"] @@ -34,7 +34,7 @@ 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 @@ -42,24 +42,24 @@ There you will find links and examples about ADR. |_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.* |=== diff --git a/docs/src/12_glossary.adoc b/docs/src/12_glossary.adoc index fa0acd3..359904a 100644 --- a/docs/src/12_glossary.adoc +++ b/docs/src/12_glossary.adoc @@ -1,7 +1,7 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-glossary]] -== Glossary +== Glosario [role="arc42help"] **** @@ -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.