Skip to content

Commit

Permalink
#1 Update 12_glossary.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
AlvaroGlezC authored May 14, 2024
1 parent da09fd8 commit 8cfaa30
Showing 1 changed file with 23 additions and 35 deletions.
58 changes: 23 additions & 35 deletions docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,28 @@ ifndef::imagesdir[:imagesdir: ../images]
[[section-glossary]]
== Glossary

[role="arc42help"]
****
.Contents
The most important domain and technical terms that your stakeholders use when discussing the system.
You can also see the glossary as source for translations if you work in multi-language teams.
.Motivation
You should clearly define your terms, so that all stakeholders
* have an identical understanding of these terms
* do not use synonyms and homonyms
.Form
A table with columns <Term> and <Definition>.
Potentially more columns in case you need translations.
.Further Information
See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
****

[cols="e,2e" options="header"]
[options="header"]
|===
|Term |Definition

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

|<Term-2>
|<definition-2>
| Term | Definition
| SYG | Name of the application developed for this project
| API | Application Programming Interface. A set of routines and methods provided by a library for use by other software
| Backend | Part of the application that implements the logical business and interacts with both the frontend and the database
| Maven | Maven is a software project management tool primarily used for building and managing dependencies in Java projects
| SpringBoot | Spring Boot is an open-source Java-based framework used for creating stand-alone, production-grade Spring-based applications effortlessly
| JPA | Is a Java specification for managing relational data in applications using object-relational mapping (ORM) techniques
| Framework | Software platform that provides a foundation and reusable components to facilitate the development of applications
| Frontend | Frontend refers to the part of a software application or website that users interact with directly
| Node | It is a server-side JavaScript runtime environment that allows developers to build scalable and high-performance network applications.
| MUI | React component library
| SASS | Sass is a preprocessor scripting language that is interpreted or compiled into Cascading Style Sheets (CSS). Sass allows for more efficient and maintainable CSS code
| Web application | Tools that a user can use by accessing a web server
| Keycloak | Keycloak is an open-source identity and access management solution.
| Continuous integration system | The practice of making automatic integrations to a project in order to detect errors prematurely
| Efficiency | Hability of working fast consuming the least amount of resources
| Integrity | The hability of being in a consistent state
| Modifiability | The hability of something to be modified easily
| Testability | Hability of something to be tested as an experiment and make decisions with the obtained results
| Usability | The hability of something to be easily used by the biggest part of users
| Privacy | The right of not sharing information if the user decides so
| Open Source | Software development model based on open collaboration
|===

0 comments on commit 8cfaa30

Please sign in to comment.