Requirement Specification
| Document | Requirement Specification |
| Author: | Heidi Muurikainen & Thin Thu Thu Thaw |
| Version: | 1.0 |
| Date: | 19.2.2024 |
Introduction
Our current project revolves around enhancing Tukko, a website dedicated to traffic visualization on a map. Initially developed as a minimum viable product (MVP) by the IoTitude team at Jyväskylä University of Applied Sciences in collaboration with Combitech Oy, Tukko utilizes public traffic data to offer real-time insights into the traffic situation on the Finnish highway network.
Client
Combitech Oy is the subscriber to the requirements specification, providing essential guidance and requirements for the project.
About the Author and Project Team
We are Duck Tape Solutions, a dynamic team of students from Jyväskylä University of Applied Sciences. Passionate about coding and learning, our team collaborates on various projects to enhance our skills. For this assignment, we are dedicated to adding new features to Tukko, contributing to its evolution.
| Name | Description | Company | Link |
|---|---|---|---|
| Heidi Muurikainen | Team leader | Duck Tape Solutions | https://www.linkedin.com/in/heidi-muurikainen/ |
| Topias Koskela | Tester | Duck Tape Solutions | https://student.labranet.jamk.fi/~ac9649/loppuharjoitus/ |
| Teemu Kytölä | General | Duck Tape Solutions | https://www.linkedin.com/in/teemu-kytölä/ |
| Toni Hytönen | OPS | Duck Tape Solutions | |
| Tho Vu | Developer | Duck Tape Solutions | https://www.linkedin.com/in/tho-vu-b8a17a24b |
| Thin Thu Thu Thaw | Security | Duck Tape Solutions | https://www.linkedin.com/in/thin-thu-thu-thaw/ |
Short Description of Service/Solution
Tukko, in its current state, serves as a minimum viable product. It operates by displaying basic information about the traffic situation on the Finnish highway network. Our goal is to expand its functionalities, making it a more robust and user-friendly tool for various stakeholders. The potential end users include individuals seeking real-time traffic information, and stakeholders, such as transportation authorities, who can benefit from comprehensive data for decision-making and planning. The enhanced Tukko aims to play a essential role in providing valuable insights for improved traffic management and user experiences.
Business goals
| ReqID | Description |
|---|---|
| BUSINESS-REQ-0001 | The Traffic Visualizer should offer a user-friendly experience for data visualization. This ensures that users can easily comprehend and make decisions based on the analyzed data presented through charts and graphs. |
| BUSINESS-REQ-0002 | Improvements to the dark mode colors should be implemented to make the Traffic Visualizer more visually comfortable, meeting the preferences and needs of users who opt for dark mode. |
| BUSINESS-REQ-0003 | The implementation of a location search feature should be user-friendly, allowing users to easily search for locations by name. This enhances the overall accessibility and convenience of the Traffic Visualizer. |
| BUSINESS-REQ-0004 | Enhancing color contrast for users with color blindness is crucial to ensure inclusivity and usability, catering to a diverse user base with varying visual abilities. |
| BUSINESS-REQ-0005 | The establishment of automated testing and quality assurance processes aims to enhance the overall stability and reliability of the Traffic Visualizer, contributing to a positive user experience. |
| BUSINESS-REQ-0006 | Providing a graphical interface for monitoring server loads is essential for efficient management and optimization of server performance, ensuring a seamless experience for users. |
| BUSINESS-REQ-0007 | Inclusion of exploratory testing in the testing process is crucial for a comprehensive evaluation of the Traffic Visualizer's features, ensuring thorough testing beyond automated processes. |
| BUSINESS-REQ-0008 | Ensuring maintainable documentation is vital for the team, facilitating efficient collaboration, troubleshooting, and future development of the Traffic Visualizer. |
Stakeholder map
Stakeholders and profiles
| Stakeholder/Profile | Info/Description | Motivation |
|---|---|---|
| Combitech Oy | Technology company collaborating with JAMK for project success | Innovating in traffic visualization technology and solutions |
| Reima Parviainen (Product Owner) | Represents Combitech's interests in the project | Ensure project aligns with Combitech's goals and requirements |
| Duck Tape Solutions (Development Team) | Student team at Jyväskylä University of Applied Sciences | Enhancing coding skills, gaining practical experience |
| Coach Marko Rintamäki | Academic coach guiding and supporting Duck Tape Solutions | Ensuring students learn effectively and complete the project |
| JAMK (Collaboration Partner) | Jyväskylä University of Applied Sciences | Fostering collaboration between students and industry partners |
| Mia Rodriguez (End User) | Multicity explorer seeking efficient travel planning | Needs real-time traffic insights and easy route planning |
| Leo Thompson (Night Shift Worker) | Night shift worker requiring smooth travel experiences | Seeks efficient routes to work during unconventional hours |
| Sofia Martinez (Weekend Explorer) | Weekend traveler looking for stress-free planning | Desires enjoyable and convenient travel experiences |
| General Users | Individuals accessing the traffic visualization service | Seeks reliable and real-time traffic information for planning |
| Admin User | User responsible for supporting and managing the service | Aims to efficiently address user needs and ensure smooth service |
Customer stories as background information
User Story 1 - Mia: The Multicity Explorer
Mia, a 30-year-old project manager, frequently travels between multiple cities for client meetings. She relies on Tukko's location search feature (FEA109) to quickly find optimal routes, ensuring she arrives on time. Utilizing the enhanced color contrast (FEA110), Mia efficiently identifies traffic conditions and selects the most time-saving routes for her business trips. Tukko's features contribute to Mia's ability to navigate various cities seamlessly, maximizing her productivity and reducing travel-related stress.
User Story 2 - Leo: The Night Shift Worker
Leo, a 35-year-old nurse, works night shifts at a hospital. Using Tukko's improved dark mode colors (FEA106 ), Leo ensures a comfortable and focused commute during late-night hours. The automated testing and quality assurance processes (FEA510) in Tukko provide Leo confidence in the app's reliability during critical hours. Tukko assists Leo in reaching work efficiently and contributing to patient care without disruptions.
User Story 3 - Sofia: The Weekend Explorer
Sofia, a 25-year-old student with a passion for weekend explorations, relies on Tukko for seamless road trips. Using the location search (FEA109)), Sofia plans her routes efficiently, avoiding congestion and ensuring a smooth journey. Tukko's commitment to color accessibility (FEA110) caters to Sofia's preferences, allowing her to easily interpret and navigate through the app's information. With Tukko's user-centric features and reliable server monitoring (FEA514), Sofia enjoys stress-free weekend adventures, exploring new destinations with confidence.
Examples of customer story
Mia starts her morning by preparing for a business trip across multiple cities. As she checks Tukko on her phone, the location search (FEA109) allows Mia to quickly find the optimal routes for her meetings. The enhanced color contrast (FEA110) helps Mia interpret the information effortlessly. Tukko becomes Mia's go-to tool, making her multicity travels efficient and stress-free.
Leo begins the evening shift at the hospital. Just before heading out, a notification from Tukko pops up on Leo's phone. Thanks to the improved dark mode colors (FEA106), Leo can easily check traffic conditions without straining the eyes. Tukko's automated testing and quality assurance processes (FEA510) provide Leo with confidence in the app's reliability during critical hours. Leo relies on Tukko for a smooth commute to the hospital, contributing to patient care without disruptions.
Sofia wakes up excited about a spontaneous weekend road trip. As she opens Tukko, the intuitive location search (FEA109) quickly helps Sofia identify interesting destinations. Sofia appreciates the enhanced dark mode (FEA106) that complements her morning routine and ensures a pleasant user experience. With Tukko, Sofia embarks on weekend explorations, discovering new destinations seamlessly and with a sense of excitement.
Customer need
| ReqID | Description |
|---|---|
| CUSTOMER-REQ-0001 | As a user, I want to visualize analyzed data in a user-friendly way, such as charts and graphs (US013). |
| CUSTOMER-REQ-0002 | As a user, I want dark mode colors to be less intense for a more comfortable visual experience (US045). |
| CUSTOMER-REQ-0003 | As a user, I want to be able to search for locations by name for enhanced navigation and user convenience (US052). |
| CUSTOMER-REQ-0004 | As a user, I want enhanced color contrast for users with color blindness to improve visibility and usability (US046). |
| CUSTOMER-REQ-0005 | As a user, I want the web app to have automated testing and quality assurance processes (US033). |
| CUSTOMER-REQ-0006 | As a user, I want a graphical interface to monitor server loads in real-time (US037). |
| CUSTOMER-REQ-0007 | As a user, I want manual and exploratory testing included in the testing process (US060). |
| CUSTOMER-REQ-0008 | As a user, I want maintainable documentation for efficient collaboration and troubleshooting (US061). |
Customer Journey paths in Service/solution
Preliminary User Stories
| User Story ID | Description | Domain |
|---|---|---|
| US045 | As a user, I want to make dark mode colors less intense for improved legibility and aesthetics. | User Interface |
| US052 | As a user, I want to search for locations by name to enhance navigation and convenience. | Navigation |
| US046 | As a user, I want to improve color contrast for users with color blindness, ensuring inclusivity and usability. | User Interface |
| US033 | As a platform engineer, I want automated testing and quality assurance processes to ensure web app stability and reliability. | Quality Assurance |
| US037 | As a administrator, I want a graphical interface to monitor server loads in real-time for better insights. | System Monitoring |
| US060 | As a product owner, I want exploratory testing included in the testing process for a comprehensive evaluation. | Quality Assurance |
| US061 | As a team member, I want maintainable documentation for efficient collaboration, troubleshooting, and future development. | Project Management |
Preliminary MockUp-prototype layouts for solution/service
MockUp
System requirements
| RequirementsID | Description |
|---|---|
| SYSTEM-HW-REQ-0001 | The frontend server must be equipped with a minimum of 4 VCPUs |
| SYSTEM-HW-REQ-0002 | The backend server must be equipped with a minimum of 4 VCPUs |
| SYSTEM-HW-REQ-0003 | The frontend server should have a memory capacity of at least 2GB |
| SYSTEM-HW-REQ-0004 | The backend server should have a memory capacity of at least 2GB for frontend operations |
Constraints and standards that affect on service design
| ReqId | Description | Source | Impact |
|---|---|---|---|
| CONSTRAINT-REQ-S00000 | User interface must be optimized for mobile devices and usable during various driving conditions (vibration, sunlight). | Industry best practices | Improved accessibility for target audience, potential development challenges. |
| CONSTRAINT-REQ-S00002 | Data access and use must comply with Finnish data privacy regulations | Finnish Personal Data Act | Protects user privacy, potential limitations on data collection and sharing. |
| CONSTRAINT-REQ-S00003 | Real-time traffic data integration should be reliable and have minimal latency. | User expectations, performance requirements | Enhanced user experience, potential infrastructure and cost considerations. |
| CONSTRAINT-REQ-S00004 | System availability and responsiveness must be high to ensure user trust and reliability. | Industry best practices | High user satisfaction, potential infrastructure and maintenance costs. |
Service primary features and functionalities
- Functions
- User can search for locations by name using an integrated search bar (FEA109).
- User can experience improved dark mode colors for enhanced visual comfort (FEA106).
- User with color blindness can choose from multiple color contrast options for readability (FEA110).
- Platform engineer can establish automated testing and quality assurance processes for stability (FEA510).
- Administrator can monitor server loads through a graphical user interface (FEA514).
- Product owner can incorporate exploratory testing methods in the testing process (FEA516).
- Team member can easily maintain and update documentation (FEA517).
- Detailed document can be found at Product Mind Map
** Priorization of essential features / functions **
- P1 = Mandatory
- P3 = Required
- P5 = Nice to have
Functional requirements of the service
| ReqID | Description | Affected Feature |
|---|---|---|
| FUNC-REQ-T0002 | The system should allow users to toggle between light and dark modes | FEA106 - Improve dark mode colors |
| FUNC-REQ-S0003 | Users should have the ability to search for locations by name | FEA109 - Search location by name |
| FUNC-REQ-C0004 | The color contrast should be adjustable for users with color blindness | FEA110 - Enhance color contrast for color blindness |
| FUNC-REQ-T0005 | Automated testing processes should be implemented for stability | FEA510 - Establish automated testing and QA processes |
| FUNC-REQ-M0006 | Server loads should be monitored with a graphical interface | FEA514 - Monitor server loads with a GUI |
| FUNC-REQ-T0007 | Manual testing should include exploratory testing | FEA516 - Manual Testing |
| FUNC-REQ-D0008 | Clear and maintainable documentation should be provided | FEA517 - Maintainable documentation |
Software / service non-functional requirements
Performance Requirements
| ReqID | Description |
|---|---|
| PERF-REQ-0000 | Searches for locations by name should yield results within 3 seconds. |
| PERF-REQ-0001 | Switching between light and dark mode should happen instantaneously. |
| PERF-REQ-0002 | Data refresh for all displayed information on the map should occur no slower than every 15 seconds. |
Security Requirements
| ReqID | Description |
|---|---|
| SEC-REQ-0001 | The password must use at least MD5-level encryption, as required by the XY112 standard |
| SEC-REQ-0002 | Regularly update and patch the application's software components and libraries to address known security vulnerabilities |
Accessability Requirements
| ReqID | Description |
|---|---|
| ACC-REQ-0000 | The application should comply with WCAG 2.1 Level AA accessibility standards. |
| ACC-REQ-0002 | All visuals and text should have sufficient color contrast for users with color blindness. |
| ACC-REQ-0003 | User should be able to use dark mode in the application |
Quality Assurance
Preliminary Acceptance Tests
| AcceptanceTestId | Description | Feature |
|---|---|---|
| ACCTEST002 - Acceptance Test 2 | Verify that dark mode colors are improved for better legibility | FEA106 - Improve dark mode colors (US045) |
| ACCTEST003 - Acceptance Test 3 | Verify that users can search for locations by name | FEA109 - Search location by name (US052) |
| ACCTEST004 - Acceptance Test 4 | Verify that color contrast is enhanced for users with color blindness | FEA110 - Enhance color contrast for color blindness (US046) |
| ACCTEST005 - Acceptance Test 5 | Verify that automated testing and quality assurance processes are established | FEA510 - Establish automated testing and quality assurance processes (US033) |
| ACCTEST006 - Acceptance Test 6 | Verify the integration of server load monitoring with a graphical user interface | FEA514 - Monitor server loads with a GUI (US037) |
| ACCTEST007 - Acceptance Test 7 | Verify that exploratory testing is included in the testing process | FEA516 - Manual Testing (US060) |
| ACCTEST008 - Acceptance Test 8 | Verify that maintainable documentation is created | FEA517 - Maintainable documentation (US061) |
Software architecture, placement view, database description, and integrations
- Link to Software architecture
Standards and sources
| ID | Name |
|---|---|
| (GDPR) | General Data Protection Regulation |
| WCAG 2.1 | Accessibility Standard |
| ISO 9000 | Quality Standard |
| Digitraffic | Digitraffic, external data source |
| OpenStreetMap | Open and Collaborative Mapping Platform |