Requirement Specification
| Document | Requirement Specification |
| Specification name | Tukko Traffic Visualizer |
| Author: | Kalle Lahtinen |
| Version: | 1.0 |
| Date: | 23-2-2024 |
Introduction
The Tukko project, originally commissioned by Combitech Finland and subsequently developed by Team IoTitude in collaboration with JAMK, enters a new phase in Future Factory 2024.
Our primary objective is to enhance and refine the already existing Tukko - Traffic Visualizer. Building upon the accomplishments of the initial assignment in WIMMA Lab 2023, where the team successfully delivered the Traffic Visualizer utilizing public traffic APIs, particularly Digitraffic, our focus now shifts towards augmenting its capabilities and addressing future requirements.
Our commitment to refining the existing Tukko involves an intricate understanding of epics and user stories, covering various aspects including user interface enhancements, data analysis, Nordic scalability, security, and improvements in infrastructure and performance.
Client
The subscriber to the requirements specification for the Tukko project, particularly in Future Factory 2024, is Combitech Finland. Combitech Finland initially commissioned the project and continues to play a pivotal role in its development.
The collaboration with JAMK further extends the stakeholders to include individuals such as Sini Karvonen and Jarmo Luostarinen, serving as Scrum Masters, and Reima Parviainen, the Product Owner.
About the author and project team
Our project team consist of six individuals. In the team we have Timi Lång as team leader, Jukka Välikangas as operations, Eetu Savolainen as tester, Kalle Lahtinen as security, Joonas Pölkki as developer and Otso Lehtiniemi as general.
I Kalle Lahtinen am the author of this document. Iam second year student at Jamk University of Applied siences and I study ICT.
Short description of service/solution
Our solution focuses on enhancing the functionality of the established Tukko Traffic Visualizer. By identifying and addressing key areas for improvement, we aim to provide a more stable and efficient traffic visualization tool. This enhancement benefits a diverse range of users.
By offering accurate real-time traffic data and advanced visualization features, our solution plays a crucial role in optimizing route planning, traffic management, and infrastructure development. This improvement ultimately contributes to smoother transportation experiences and improved mobility for all stakeholders involved.
Business requirements / goals?
| ReqID | Description |
|---|---|
| BUSINESS-REQ-0001 | Increase the overall user numbers of the site |
| BUSINESS-REQ-0002 | Enhance the user friendlines of the product |
| BUSINESS-REQ-0003 | Improve the data protection of the service |
| BUSINESS-REQ-0004 | Implement a feedback mechanism to gather user opinions and suggestions for future improvements |
| BUSINESS-REQ-0005 | Implement security authentication for users |
Stakeholder map
Stakeholders and profiles
| Stakeholde/profile | Info / Link to description | Motivation |
|---|---|---|
| Stakeholder 1: Combitech | Combitech website | Is the customer that wants us to improve Tukko |
| Stakeholder 2: Reima Parviainen | Product owner | Is the bridge between us the students and the customer |
| Stakeholder 3: Marko Rintamäki | Coach | Marko coaches all the teams which are in this project |
Customer story's as background information
Customer Story 1 - Regular user 1
User1, Commuter Profile:User1 User, a busy professional who commutes to work daily using public transportation, relies on accurate and real-time information about traffic conditions to plan his routes efficiently and minimize delays. One morning, before leaving home, he opens the Tukko Traffic Visualizer on his smartphone to check the current traffic situation along his usual route. Using the interactive map feature, he quickly identifies any congestion or incidents along his planned route and decides to take an alternate route suggested by the app to avoid heavy traffic and arrive at his destination on time. By leveraging Tukko Traffic Visualizer, User successfully navigates through the city using the most optimal route, saving time and reducing stress during his commute. He appreciates the convenience and reliability of the app, which helps him make informed decisions and adapt to changing traffic conditions effectively.
Customer Story 2 - Regular user 2
User2, Urban Planner User, an urban planner responsible for analyzing traffic patterns and optimizing transportation systems, relies on comprehensive data and visualizations to improve the city's mobility experience. Tasked with evaluating recent traffic management initiatives, he uses the Tukko Traffic Visualizer platform to access real-time traffic data and visualize patterns across different regions. Leveraging Tukko's advanced analytics tools, User identifies areas for improvement and optimization, contributing to more efficient and sustainable transportation systems and enhancing residents' quality of life.
Customer requirements for User1
| ReqID | Description |
|---|---|
| CUSTOMER-REQ-0001 | User1 needs access to accurate and up-to-date information about traffic conditions along his planned route to make informed decisions. |
| CUSTOMER-REQ-0002 | User1 requires an interactive map feature that allows him to visualize traffic congestion, incidents, and alternative routes easily. |
| CUSTOMER-REQ-0003 | User1 prefers a user-friendly interface that is intuitive and easy to navigate, ensuring a seamless experience while using the app. |
| CUSTOMER-REQ-0004 | User1 relies on the reliability and consistency of Tukko Traffic Visualizer to provide accurate traffic information consistently, helping him plan her commute efficiently. |
Customer Journey paths in Service/solution
Customer journey for User1
Preliminary User Stories
| User Story ID | Description / link to issue |
|---|---|
| US045 | As a user, I want the dark mode colors to not pop out as much. #US045 |
| US046 | As a user with color blindness, I want the web app to have sufficient color contrast between text and background elements, so that, I can easily read and understand the content. #US046 |
| US002 | As a user, I want to be able to create an account and securely authenticate myself to the web app. #US002 |
| US004 | As a customer I want secure authentication mechanisms, such as password hashing and session management, to protect user accounts. #US004 |
| US005 | As a user, I want to save some favourite LAM stations to my account. #US005 |
| US060 | As a product owner I want the testing to include exploratory testing. #US060 |
| US061 | As a team member I want to have maintainable documentation. #US061 |
Selected Use Cases of service/solution
| Use Case | Domain |
|---|---|
| Adjust Dark Mode Colors | User Preferences |
| Ensure Sufficient Contrast | User Interface |
| Create Account | User Authentication |
| Implement Secure Authentication Mechanisms | User Authentication |
| Add Favorite Stations to Account | User Preferences |
| Perform Exploratory Testing | Quality Assurance |
| Maintain Documentation | Software Development |
Preliminary MockUp-prototype layouts for solution/service
-
Link to our MockUp-prototypes Link to the prototype/MockUp
-
One picture as a reference
System requirements
| RequirementsID | Description |
|---|---|
| SYSTEM-HW-REQ-0001 | Tukko Traffic Visualizer is produced as a Software as a Service (SAAS) solution |
| SYSTEM-HW-REQ-0002 | Tukko Traffic Visualizer should have 100% uptime |
| SYSTEM-HW-REQ-0003 | Stable data storage and archiving capabilities are required to store various types of data |
Constraints and standards that affect on service design
| ReqId | Description |
|---|---|
| CONSTRAINT-REQ-S00001 | Compliance with laws and regulations, such as the EU GDPR Act, governing data privacy and protection, impacts service design and implementation |
| CONSTRAINT-REQ-S00002 | Adherence to industry standards, like ISO 27001 for information security management, influences the design and development of the service. |
| CONSTRAINT-REQ-S00003 | Accessibility standards, such as WCAG for web content accessibility, must be followed to ensure inclusivity and compliance with legal requirements. |
| CONSTRAINT-REQ-S00004 | Regulatory constraints related to specific industries, like HIPAA for healthcare data, impact how data is handled and stored within the service. |
Service primay features and functionalities
- Functions
- The user can use dark mode
- The color contrast are more enhanced
- The users can be verified
- The users can easily access and reference preferred monitoring points within a local area monitoring system
- The product will be manually tested
- The written materials are easily updated and understood
Functional requirements of the service
| ReqID | Description | Affected feature? |
|---|---|---|
| FUNC-REQ-C0001 | The service must incorporate improvements to dark mode colors to ensure they do not strain user eyes and provide a pleasant viewing experience. | Feature 1 - Improve dark mode colors |
| FUNC-REQ-C0002 | Users with color blindness should experience enhanced color contrast between text and background elements, ensuring readability and comprehension of content. | Feature 2 - Enhance color contrast for color blindness |
| FUNC-REQ-C0003 | Secure user authentication mechanisms, including password hashing and session management, must be implemented to protect user accounts from unauthorized access. | Feature 3 - Securely authenticate user accounts |
| FUNC-REQ-C0004 | allowing users to save their preferred LAM stations within their user account for easy access. LAM stations refer to "automatic traffic measurement stations". | Feature 4 - Save favourite LAM stations to user account |
Software / service non-functional requirements
Performance Requirements
| ReqID | Description |
|---|---|
| PERF-REQ-0000 | The service must be responsive, with a maximum acceptable response time of 500 milliseconds for any user action |
| PERF-REQ-0001 | The system should be able to handle a minimum of 1000 concurrent users without experiencing performance degradation |
| PERF-REQ-0002 | The service should achieve a minimum uptime of 99.9%, ensuring high availability for users at all times |
| PERF-REQ-0003 | The service must be scalable to accommodate increasing user demands and traffic volumes without compromising performance |
| PERF-REQ-0004 | The system should maintain a low memory footprint, consuming no more than 1 GB of RAM under typical usage scenarios |
Security Requirements
| ReqID | Description |
|---|---|
| SEC-REQ-0001 | All user authentication processes must adhere to industry-standard encryption protocols to ensure data privacy and security |
| SEC-REQ-0002 | The system must implement secure password storage mechanisms, such as salted hashing, to protect user credentials |
| SEC-REQ-0003 | Access to sensitive user data must be restricted based on role-based access control (RBAC) principles |
| SEC-REQ-0004 | The system should have mechanisms in place to detect and prevent common security threats, such as SQL injection attacks |
| SEC-REQ-0005 | Regular security audits and vulnerability assessments must be conducted to identify and address potential security risks |
Accessability Requirements
| ReqID | Description |
|---|---|
| ACC-REQ-0000 | The web application must comply with WCAG (Web Content Accessibility Guidelines) standards to ensure accessibility for users with disabilities |
| ACC-REQ-0001 | All user interface elements must be operable via keyboard navigation to accommodate users who cannot use a mouse |
| ACC-REQ-0002 | The application must provide sufficient color contrast between text and background elements to facilitate readability for users with visual impairments |
| ACC-REQ-0003 | Alternative text descriptions must be provided for all non-text content, such as images, to assist users who rely on screen readers |
| ACC-REQ-0004 | The application should support screen reader compatibility and provide semantic HTML markup for optimal accessibility |
Quality Assurance
Product quality assurance entails a comprehensive approach to testing and validation, covering various aspects such as functional correctness, performance efficiency, security stablesness, usability, compatibility across different platforms, regression to ensure new features don't break existing functionality, integration with other systems, maintainability for ease of future updates, compliance with industry standards and regulations, and finally, user acceptance testing to confirm alignment with user needs and expectations.
By addressing these areas diligently, software products can achieve higher reliability, security, usability, and overall quality, leading to enhanced user satisfaction and trust.
- Link to Master Test Plan
Standards and sources
- General Data Protection Regulation (GDPR): This regulation protects privacy and gives individuals control over their personal data.
- ePrivacy Directive: This directive complements the GDPR and provides rules on confidentiality of communications and tracking technologies such as cookies.
- Directive on the legal protection of computer programs ('Software Directive'): This directive protects computer programs by means of copyright.
- Directive on the enforcement of intellectual property right ('IPRED'): This directive enforces intellectual property rights.
- Directive on the legal protection of databases ('Database Directive'): This directive protects databases.
- EU Cybersecurity Act: This act ensures safer hardware and software.
- Digital contract rules: These rules make it easier for consumers and businesses to buy and sell digital content, digital services, goods, and 'smart goods' in the EU.
Please note that these are just a few examples and the specific laws and rules may vary depending on the context and the specific needs of your software service. It's always a good idea to consult with a legal expert to ensure compliance with all relevant laws and regulations.