Pular para o conteúdo principal

Requirements

This document describes the functional and non-functional requirements for the Taça UA sports management platform.


Functional Requirements (FR)

FR1 - User Management and Authentication

IDDescription
FR1.1The system must allow authentication for General Administrator and Core Administrators.
FR1.2The system must assign access permissions according to the administrator type.
FR1.3The public can access public information without authentication.
FR1.4The General Administrator can manage Core Administrators.

FR2 - Competition Management (General Administrator)

IDDescription
FR2.1The General Administrator can create, edit, and remove courses.
FR2.2The General Administrator can create/associate Core Administrators to each course.
FR2.3The General Administrator can manage and publish general regulations and specific regulations for each sport.
FR2.4The General Administrator can start and end sports seasons.

FR3 - Sport and Tournament Management (General Administrator)

IDDescription
FR3.1The General Administrator can create and configure tournaments for their sport.
FR3.2The General Administrator can schedule and edit games (teams, location, date, time).
FR3.3The General Administrator can manage the sport's game calendar.
FR3.4The General Administrator can register and update game results.
FR3.5The General Administrator can define the sport's scoring system (according to regulations) for each tournament type (e.g., 140 points for 1st place in a recurring team sport of tier A).

FR4 - Course Team Management (Secondary Administrator - Core Administrator)

IDDescription
FR4.1The Core Administrator can create and manage players (students and technical staff) by course. Members are typed: student for athletes and technical_staff for coaches/managers.
FR4.2The Core Administrator can create and manage teams by sport.
FR4.3The Core Administrator can enroll athletes in a team including their Student ID Number.
FR4.4The platform automatically verifies if the athlete is a member, based on a list uploaded by the General Administrator. If not a member, the platform visually marks it (e.g., red dot).

FR5 - Transparency and Communication (Public and General)

IDDescription
FR5.1The platform must provide a complete calendar (calendar that redirects to a page depending on the day).
FR5.1.1The public must have the option to view the calendar filtered by sport or course.
FR5.2Results must be public and updated.
FR5.3The public must be able to consult rankings by sport.
FR5.4The public must be able to consult general rankings.
FR5.5The public must be able to consult general and specific regulations.
FR5.6The public must be able to view previous results, as well as past years' rankings.
FR5.7The public must be able to consult historical matches and rankings filtered by past season.

FR6 - Scoring System and General Ranking

IDDescription
FR6.1The system automatically calculates course scores by sport.
FR6.2The system calculates and updates the Taça UA General Ranking.

FR7 - Game Management (Core Administrator)

IDDescription
FR7.1The Core Administrator can assign players, present in relevant teams, to the game. Only these players will be eligible to participate in the specific game.
FR7.2The Core Administrator can assign an equipment number to the player.
FR7.3The Core Administrator can add comments regarding the game.
FR7.4The Core Administrator can generate the game sheet in PDF format with the information referenced in the functional requirements described above (FR7.[1|2|3]).

Non-Functional Requirements (NFR)

NFR1 - Usability

IDDescription
NFR1.1The system must present a responsive design adapted for desktop, tablet, and smartphone.
NFR1.2The interface must be intuitive and use terminology recognized by the academic community.
NFR1.3Automatic data updates, without the need for manual refresh.
NFR1.4The platform must comply with accessibility standards.
NFR1.5Navigation must require a maximum of 3 clicks to reach any main functionality.
NFR1.6There must be an efficient search system and filters for calendar, teams, and results.

NFR2 - Performance

IDDescription
NFR2.1Response time must be less than 2 seconds in 95% of requests.
NFR2.2Caching techniques must be implemented to reduce load on calendar and results queries.
NFR2.3The system must support horizontal scalability to accommodate future growth.

NFR3 - Security

IDDescription
NFR3.1All credentials and sensitive data must be encrypted.
NFR3.2The system must log administrative operations and critical access.
NFR3.3Access control must follow the principle of least privilege.
NFR3.4There must be protection against common attacks (SQL Injection, XSS, Bruteforce).
NFR3.5Administrative accounts must have strong authentication.

NFR4 - Reliability and Availability

IDDescription
NFR4.1Minimum availability of 99.99% during the competitive period.
NFR4.2The system must perform automatic daily backups.
NFR4.3The system must avoid inconsistencies in the general ranking, ensuring referential data integrity.

NFR5 - Compatibility

IDDescription
NFR5.1Compatibility with the most used browsers (Chrome, Firefox, Edge, Safari).

NFR6 - Maintainability and Evolution

IDDescription
NFR6.1Code must follow clean development standards (e.g., SOLID, MVC, RESTful).
NFR6.2The system must allow continuous updates with approximately zero downtime.
NFR6.3Technical documentation must be updated with each release.
NFR6.4The system must support future inclusion of new sports and categories without the need for deep restructuring.
NFR6.5The system must provide application user manuals for non-technical administrators.

NFR7 - Monitoring and Auditing

IDDescription
NFR7.1Logs must be available for auditing throughout the competition.
NFR7.2The system must issue alerts in case of service failures or critical errors.
NFR7.3The system must support performance and server load monitoring through tools like Grafana/Prometheus, including metrics such as CPU, memory, number of requests, errors, and latency.

Note: All requirements are measurable and verifiable through functional testing, access reviews, report exports, and real-time notification simulations.