generated from Arquisoft/wiq_0
-
Notifications
You must be signed in to change notification settings - Fork 0
MM 04 ‐ Remote 02
Pablo García-Ovies Pérez edited this page Feb 20, 2024
·
6 revisions
- Date: 10/02/2024 - 09:30
- Location: Remote
- Samuel Bustamante Larriet (UO289689)
- Pablo García-Ovies Pérez (UO265314)
- Mª Teresa González García (UO288347)
- Alberto Lago Conde (UO288245)
- Pablo Barrero Cruz (UO289642)
- Hugo Méndez Fernández (UO288543)
- Daniel Andina Pailos (UO287791)
- Review of documentation work done.
- Project name
- Provisional adoption of the application name: 'Wikidata Infinite Quest'.
- Use PlantUML.
- Correct and standardize the table format.
- Incorporate explanatory text in sections featuring only tables or diagrams to enhance context and understanding.
- Use general systems or technologies instead of particular implementations where there is not a concrete decission towards what will be used. E.g., the term 'database' as a convention instead of the specific MongoDB until a decision is made.
- Include title.
- Unidirectional > Bidirectional arrows
- Exchanges with two unidirectional lines.
- Consistency using the same forms for all systems; if not, explain the differences.
- Acronyms / Abbreviations -> If not well known, avoid them.
- Labels for arrows indicating in one or two words what the flow of information is.
- Be cautious with color contrasts (preferably use blue) and ensure they are meaningful.
- Place the most important elements of the diagram in the center.
- Always include a legend explaining the meaning of each symbol (continuous/dashed arrows, colors, shapes...).
- Exception: Standardized diagrams (such as inheritance in UML).
- First approach for the documentation.
- Pending:
- Improve diagrams quality according to tips given in class, unifying also the format (PlantUML) where possible.
- Set table settings properly.
- Include explanation test to the documentation points in which it is required.
Each group will improve the following documentation points out of arc42:
- 01 - introduction_and_goals
- 04 - solution_strategy
- 07 - deployment_view
- 10 - quality_requirements
- 02 - architecture_constraints
- 05 - building_block_view
- 08 - concepts
- 11 - technical_risks
- 03 - system_scope_and_context
- 06 - runtime_view
- 09 - architecture_decisions
- 12 - glossary