Requirements traceability - ESG-Project/documentation GitHub Wiki

← Home / Requirements

Requirements Traceability

This document provides a comprehensive mapping between user stories, system use cases, and their corresponding UI prototypes using UML principles. It serves as a central reference for tracking the implementation status of each requirement and its associated artifacts.

Overview

The traceability matrix follows UML principles to show the relationships between:

  • User Stories (USxx) - Represented as Requirements
  • System Use Cases (UCxx) - Represented as Use Cases
  • UI Prototypes (Figma links) - Represented as Artifacts

Relationship Types

  • Realization (⟶): User Story is realized by Use Case
  • Implementation (⟹): Use Case is implemented by UI Prototype
  • Dependency (⟷): Related requirements that depend on each other

Traceability Matrix

User Management

Requirement Realizes Implementation Dependencies
US01 ⟶ UC01. Maintain user profile ⟹ Profile page, Profile edit page None
US02 ⟶ UC02. Maintain technicians ⟹ Techs list page, Tech register page (profile), Tech register page (address), Tech edit page US01
US03 ⟶ UC03. Maintain clients ⟹ Clients list page, Client register page (profile), Client register page (address), Client edit page, Client profile page US01, US02

Project Management

Requirement Realizes Implementation Dependencies
US04 ⟶ UC04. Maintain projects ⟹ Projects list page, Project register page (id), Project register page (address), Project edit page, Project info page US03
US05 ⟶ UC05. Access project location on the map ⟹ Project geolocation US04

Documental Management

Requirement Realizes Implementation Dependencies
US06 ⟶ UC06. Maintain environmental licenses ⟹ Licenses list page, Enterprises all licenses list page, License register page, License edit page US04
US07 ⟶ UC07. Maintain conditionings ⟹ Conditionings list page, Conditioning due dates list page, Conditioning register page, Conditioning edit page US06
US08 ⟶ UC08. Maintain protocols ⟹ Protocols list page, Enterprises all protocols list page, Protocol register page, Protocol edit page US04
US09 ⟶ UC09. Maintain crafts ⟹ Crafts list page, Enterprises all crafts list page, Craft register page, Craft edit page US04
US10 ⟶ UC10. Maintain complements ⟹ Complements list page, Complement register page US09
US11 ⟶ UC11. Receive email notification ⟹ Notification via e-mail US06, US07, US08, US09
US12 ⟶ UC12. Expiration summary ⟹ No prototype available US11

System Administration

Requirement Realizes Implementation Dependencies
US13 ⟶ UC13. Maintain system parameters ⟹ No prototype available None

Commercial Management

Requirement Realizes Implementation Dependencies
US14 ⟶ UC14. Maintain enterprise products ⟹ No prototype available US13
US15 ⟶ UC15. Maintain commercial proposals ⟹ No prototype available US03, US14
US16 ⟶ UC16. Generate and export commercial proposal ⟹ No prototype available US15
US17 ⟶ UC17. Change proposal status ⟹ No prototype available US15

Financial Management

Requirement Realizes Implementation Dependencies
US18 ⟶ UC18. Maintain financial transactions ⟹ No prototype available None

UML Relationship Legend

Realization (⟶)

  • Indicates that a User Story is realized by a Use Case
  • Shows the implementation relationship between requirements and use cases

Implementation (⟹)

  • Indicates that a Use Case is implemented by UI Prototypes
  • Shows the concrete implementation of use cases

Dependencies (⟷)

  • Shows which requirements depend on others
  • Helps identify implementation order and impact analysis

Version Control

Version Date Author Changes
1.0 2024-04-26 System Initial version

Notes

  • Each user story is mapped to its corresponding system use case using UML realization relationships
  • UI prototypes are linked where available using UML implementation relationships
  • Dependencies between requirements are explicitly shown
  • Missing prototypes indicate features still in development
  • Regular updates are made to reflect implementation progress

Related Documents