felixalb/asura-tmdb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update Vision Document

Kristoffer Juelsenn 2022-04-28 17:26:08 +02:00 committed by Felix Albrigtsen
parent e2cda9c09f
commit 99b9ab94fa
1 changed files with 220 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

293
Vision-Document.md

@ -1,114 +1,113 @@
**Group 1** **Group 1**
**Asura Tournament System** # Asura Tournament System
Vision **Vision**
**Version 1** **Version 1.0**
**Revision History**
## Revision History
| **Date** | **Version** | **Description** | **Author** | | **Date** | **Version** | **Description** | **Author** |
| --- | --- | --- | --- | |----------|-------------|-----------------|------------|
| 06/03/22 | 0.1 | Preliminary Draft | Felix Albrigtsen,Jonas Jødestøl Haugland,Kristoffer Juelsen,Kristoffer Longva Eriksen | | 06/03/22 | 0.1 | Preliminary Draft | Felix Albrigtsen,Jonas Jødestøl Haugland,Kristoffer Juelsen,Kristoffer Longva Eriksen |
| 16/03/22 | 0.2 | Changes according to supervisor meeting | Jonas Jødestøl Haugland,Kristoffer Juelsen | | 16/03/22 | 0.2 | Changes according to supervisor meeting | Jonas Jødestøl Haugland,Kristoffer Juelsen |
| 18/03/2022 | 1.0 | Final Draft | Felix Albrigtsen,Jonas Jødestøl Haugland,Kristoffer Juelsen | | 18/03/2022 | 1.0 | Final Draft | Felix Albrigtsen,Jonas Jødestøl Haugland,Kristoffer Juelsen |
**Table of Contents** ## Table of Contents
[1 Introduction](#_Toc97497362) [1 Introduction](#\_Toc97497362)
[1.1 Purpose and scope](#_Toc97497363) [1.1 Purpose and scope](#\_Toc97497363)
[1.2 Definitions, Acronyms, and Abbreviations](#_Toc97497364) [1.2 Definitions, Acronyms, and Abbreviations](#\_Toc97497364)
[1.3 References](#_Toc97497365) [1.3 References](#\_Toc97497365)
[1.4 Overview](#_Toc97497366) [1.4 Overview](#\_Toc97497366)
[2 Positioning](#_Toc97497367) [2 Positioning](#\_Toc97497367)
[2.1 Business Opportunity](#_Toc97497368) [2.1 Business Opportunity](#\_Toc97497368)
[2.2 Problem Statement](#_Toc97497369) [2.2 Problem Statement](#\_Toc97497369)
[2.3 Product Position Statement](#_Toc97497370) [2.3 Product Position Statement](#\_Toc97497370)
[3 Project goals](#_Toc97497371) [3 Project goals](#\_Toc97497371)
[3.1 Impact goals](#_Toc97497372) [3.1 Impact goals](#\_Toc97497372)
[3.2 Result goals](#_Toc97497373) [3.2 Result goals](#\_Toc97497373)
[3.3 Process goals](#_Toc97497374) [3.3 Process goals](#\_Toc97497374)
[4 Stakeholder and User Descriptions.](#_Toc97497375) [4 Stakeholder and User Descriptions.](#\_Toc97497375)
[4.1 Market Demographics](#_Toc97497376) [4.1 Market Demographics](#\_Toc97497376)
[4.2 Stakeholder Summary](#_Toc97497377) [4.2 Stakeholder Summary](#\_Toc97497377)
[4.3 User Summary](#_Toc97497378) [4.3 User Summary](#\_Toc97497378)
[4.4 User Environment](#_Toc97497379) [4.4 User Environment](#\_Toc97497379)
[4.5 Key Stakeholder or User Needs](#_Toc97497380) [4.5 Key Stakeholder or User Needs](#\_Toc97497380)
[4.6 Alternatives and Competition](#_Toc97497381) [4.6 Alternatives and Competition](#\_Toc97497381)
[4.6.1 Challonge](#_Toc97497382) [4.6.1 Challonge](#\_Toc97497382)
[5 Product Overview](#_Toc97497383) [5 Product Overview](#\_Toc97497383)
[5.1 Product Perspective](#_Toc97497384) [5.1 Product Perspective](#\_Toc97497384)
[5.2 Summary of Capabilities](#_Toc97497385) [5.2 Summary of Capabilities](#\_Toc97497385)
[5.3 Assumptions and Dependencies](#_Toc97497386) [5.3 Assumptions and Dependencies](#\_Toc97497386)
[5.4 Risk analysis](#_Toc97497387) [5.4 Risk analysis](#\_Toc97497387)
[5.5 Installation](#_Toc97497388) [5.5 Installation](#\_Toc97497388)
[6 Product Features](#_Toc97497389) [6 Product Features](#\_Toc97497389)
[6.1 Intuitive web interface](#_Toc97497390) [6.1 Intuitive web interface](#\_Toc97497390)
[6.2 User management](#_Toc97497391) [6.2 User management](#\_Toc97497391)
[6.3 Easy Collaboration](#_Toc97497392) [6.3 Easy Collaboration](#\_Toc97497392)
[6.4 Automatic Bracketing](#_Toc97497393) [6.4 Automatic Bracketing](#\_Toc97497393)
[6.5 Scheduling](#_Toc97497394) [6.5 Scheduling](#\_Toc97497394)
[7 Constraints](#_Toc97497395) [7 Constraints](#\_Toc97497395)
[8 Quality Ranges](#_Toc97497396) [8 Quality Ranges](#\_Toc97497396)
[9 Precedence and Priority](#_Toc97497397) [9 Precedence and Priority](#\_Toc97497397)
[10 Other Product Requirements](#_Toc97497398) [10 Other Product Requirements](#\_Toc97497398)
[10.1 Applicable Standards](#_Toc97497399) [10.1 Applicable Standards](#\_Toc97497399)
[10.2 System Requirements](#_Toc97497400) [10.2 System Requirements](#\_Toc97497400)
[10.3Performance Requirements](#_Toc97497401) [10.3Performance Requirements](#\_Toc97497401)
[11 Documentation Requirements](#_Toc97497402) [11 Documentation Requirements](#\_Toc97497402)
[11.1 User Manual](#_Toc97497403) [11.1 User Manual](#\_Toc97497403)
[11.2 Internal Documentation](#_Toc97497404) [11.2 Internal Documentation](#\_Toc97497404)
[11.3 Installation Guides, Configuration, and Readme File](#_Toc97497405) [11.3 Installation Guides, Configuration, and Readme File](#\_Toc97497405)
Vision Vision
# 1 **Introduction** # 1 **Introduction**
This document provides and describes the requirements and features of the "Asura Tournament System", which is the project for the course "DCST1008 – Systemutvikling". The assignment consists of developing a tournament system for a specified stakeholder. The assignment is well defined and is presented as a task to create a management system for multi-team tournaments, where the primary user should be the tournament administrator. This document provides and describes the requirements and features of the "Asura Tournament System", which is the project for the course "DCST1008 – Systemutvikling". The assignment consists of developing a tournament system for a specified stakeholder. The assignment is well defined and is presented as a task to create a management system for multi-team tournaments, where the primary user should be the tournament administrator.
The Introduction includes relevant information that will be used and referenced throughout the document. The Introduction includes relevant information that will be used and referenced throughout the document.
@ -128,14 +127,13 @@ UD – Universal Design
## 1.3 References ## 1.3 References
[1] WCAG 2.1 \[1\] WCAG 2.1
This is the standard which we will base our development on, to include Universal Design and accommodate for anyone who wishes to use or explore our products features. This is the standard which we will base our development on, to include Universal Design and accommodate for anyone who wishes to use or explore our products features. <https://www.w3.org/TR/WCAG21/>
[https://www.w3.org/TR/WCAG21/](https://www.w3.org/TR/WCAG21/)
Don Norman&#39;s principles of Interaction design Don Norman's principles of Interaction design
[https://www.educative.io/edpresso/what-are-normans-design-principles](https://www.educative.io/edpresso/what-are-normans-design-principles) <https://www.educative.io/edpresso/what-are-normans-design-principles>
## 1.4 Overview ## 1.4 Overview
@ -148,23 +146,19 @@ The rest of the Vision document is organized in different sections where the inf
In the ever-increasing landscape of competitions and tournaments, there is a growing need for a simple and effective system to handle many users without the need for end users to worry about the infrastructure and organization of any tournament they would want to host. With this project we wish to decrease the workload put on hosts, and let the administrators focus on the game rather than the technology. In the ever-increasing landscape of competitions and tournaments, there is a growing need for a simple and effective system to handle many users without the need for end users to worry about the infrastructure and organization of any tournament they would want to host. With this project we wish to decrease the workload put on hosts, and let the administrators focus on the game rather than the technology.
## 2.2 Problem Statement ## 2.2 Problem Statement
| The problem of | Easily hosting tournaments without the need for much manual labor | | The problem of | Easily hosting tournaments without the need for much manual labor |
| --- | --- | |----------------|-------------------------------------------------------------------|
| affects | The Asura gaming community | | affects | The Asura gaming community |
| the impact of which | Creates lots of extra work for management and moderators that wish to host a tournament or event | | the impact of which | Creates lots of extra work for management and moderators that wish to host a tournament or event |
| a successful solution would be | Easily managed | a successful solution would be | Easily managed<br>Have a fast-paced setup and completion<br>Accessible and easily implemented |
Have a fast-paced setup and completion
Accessible and easily implemented |
## 2.3 Product Position Statement ## 2.3 Product Position Statement
| For | The management of a large, international, gaming community that hosts events and tournaments. | | For | The management of a large, international, gaming community that hosts events and tournaments. |
| --- | --- | |-----|-----------------------------------------------------------------------------------------------|
| Who | Wishes to more easily create online tournaments and lessen the workload for the organizers | | Who | Wishes to more easily create online tournaments and lessen the workload for the organizers |
| The (product name) | Is a web application that can be accessed by the specified user | | The (product name) | Is a web application that can be accessed by the specified user |
| That | Provides a good and accessible solution that is upheld to international standards and implemented in such a way that anyone would be able to utilize the product given the right documentation and manuals. | | That | Provides a good and accessible solution that is upheld to international standards and implemented in such a way that anyone would be able to utilize the product given the right documentation and manuals. |
| Unlike | &quot;Challonge&quot;, another tournament hosting website | | Unlike | "Challonge", another tournament hosting website |
| Our product | Should be accessible to anyone who needs to use the system and correspond to international standards regarding Universal Design, as well as being straight-forward and simple to use in addition to having smart and useful features. | | Our product | Should be accessible to anyone who needs to use the system and correspond to international standards regarding Universal Design, as well as being straight-forward and simple to use in addition to having smart and useful features. |
# 3 Project goals # 3 Project goals
@ -181,8 +175,8 @@ In the ever-increasing landscape of competitions and tournaments, there is a gro
## 3.2 Result goals ## 3.2 Result goals
- Hand in deliverables on time - Hand in deliverables on time
- Develop a good product that meets the customers&#39; expectations and needs - Develop a good product that meets the customers' expectations and needs
- Create a product that follows necessary standards such as UD, WCAG 2.1[1] and provides accessibility for anyone who needs to use the system - Create a product that follows necessary standards such as UD, WCAG 2.1\[1\] and provides accessibility for anyone who needs to use the system
## 3.3 Process goals ## 3.3 Process goals
@ -201,23 +195,18 @@ We would like the market demographic to continue growing as the customer expands
By creating this project, we can increase the member retention and also member engagement, resulting in increased activity and growth. This would also in some cases lead to an increase in turnover for the customer. By creating this project, we can increase the member retention and also member engagement, resulting in increased activity and growth. This would also in some cases lead to an increase in turnover for the customer.
## 4.2 Stakeholder Summary ## 4.2 Stakeholder Summary
| **Name** | **Description** | **Responsibilities** | | **Name** | **Description** | **Responsibilities** |
| --- | --- | --- | |----------|-----------------|----------------------|
| Community Management | End user | Community Management | End user | Add and manage Community Moderators Approve tournaments and manage tournaments Organize and create tournaments |
| Add and manage Community Moderators Approve tournaments and manage tournaments Organize and create tournaments |
| Community Members | Will not be able to manage the system, only view the tournaments Is the group of people who will participate in the tournaments | None | | Community Members | Will not be able to manage the system, only view the tournaments Is the group of people who will participate in the tournaments | None |
| Community Moderators | The people who primarily organize the tournaments with approval from management End user | Organize and create tournaments | | Community Moderators | The people who primarily organize the tournaments with approval from management End user | Organize and create tournaments |
| Course Lecturer | End user | View the final product and guide the production through iterations | | Course Lecturer | End user | View the final product and guide the production through iterations |
| Teaching Assistant | End user | View the product during production and comment on potential improvements | | Teaching Assistant | End user | View the product during production and comment on potential improvements |
| Project Developers | End user and developer of product | Create and manage the product Responsible for maintenance and further development | Project Developers | End user and developer of product | Create and manage the product Responsible for maintenance and further development<br>Communication with the customer, lecturers, and teaching assistants |
Communication with the customer, lecturers, and teaching assistants |
## 4.3 User Summary ## 4.3 User Summary
| **Name** | **Description** | **Responsibilities** | **Stakeholder** | | **Name** | **Description** | **Responsibilities** | **Stakeholder** |
| --- | --- | --- | --- | |----------|-----------------|----------------------|-----------------|
| Community Managers | Leaders of the customer organizations | Manage tournaments Manage tournament organizers Manage archive | Self-represented | | Community Managers | Leaders of the customer organizations | Manage tournaments Manage tournament organizers Manage archive | Self-represented |
| Community Moderators | Moderators of the community | Organize tournaments Who this is can change and it is a varied group of people | Community Managers | | Community Moderators | Moderators of the community | Organize tournaments Who this is can change and it is a varied group of people | Community Managers |
| Community Members | Guests | View tournaments if they wish | Self-represented | | Community Members | Guests | View tournaments if they wish | Self-represented |
@ -231,24 +220,18 @@ There are no set tasks, as most of the work is voluntary coming from the moderat
This is an online operation, so no environmental constraints will be liable, other than some moderators or users being unavailable due to local environmental problems. Current platforms are three different games, two of which are located on steam, the other on an individual platform. One of these games is a plan for future development but is close to being implemented. This is an online operation, so no environmental constraints will be liable, other than some moderators or users being unavailable due to local environmental problems. Current platforms are three different games, two of which are located on steam, the other on an individual platform. One of these games is a plan for future development but is close to being implemented.
The only other application in use that could be directly utilized by us as system developers is Discord and integrating this with either Discord to login or to be able to format messages to be sent to the communities&#39; channels. This, however, is not a priority for us and will only be implemented by necessity. The only other application in use that could be directly utilized by us as system developers is Discord and integrating this with either Discord to login or to be able to format messages to be sent to the communities' channels. This, however, is not a priority for us and will only be implemented by necessity.
## 4.5 Key Stakeholder or User Needs ## 4.5 Key Stakeholder or User Needs
| **Need** | **Priority** | **Concerns** | **Current Solution** | **Proposed Solutions** | | **Need** | **Priority** | **Concerns** | **Current Solution** | **Proposed Solutions** |
| --- | --- | --- | --- | --- | |----------|--------------|--------------|----------------------|------------------------|
| Create a Tournament | High | | Create a Tournament | High | | None | Web application UI |
| None | Web application UI |
| Manage Tournaments | High | Cooperation, multiple admins | None | Web application UI | | Manage Tournaments | High | Cooperation, multiple admins | None | Web application UI |
| View Tournaments &amp; standings | High | | View Tournaments & standings | High | | None | Web application UI |
| None | Web application UI | | Complete tournament and announce a winner | Medium | | None | Web application and Discord |
| Complete tournament and announce a winner | Medium | | Archive tournaments | Low | | None | Export summary |
| None | Web application and Discord |
| Archive tournaments | Low |
| None | Export summary |
| User notifications | Medium | Integration with discord | None | Discord or Email | | User notifications | Medium | Integration with discord | None | Discord or Email |
| Login system for organizers | High | Security, privacy | | Login system for organizers | High | Security, privacy | | Web interface with cookies/browser storage |
| Web interface with cookies/browser storage |
## 4.6 Alternatives and Competition ## 4.6 Alternatives and Competition
@ -303,19 +286,123 @@ Here we have listed possible events and analyzed the probability and consequence
- The NTNU-IDI MySQL database seems stable, but we can easily change to any other MySQL instance. - The NTNU-IDI MySQL database seems stable, but we can easily change to any other MySQL instance.
- The installation manual will be devised for easy reinstallation if we must. - The installation manual will be devised for easy reinstallation if we must.
| **What** | **Probability** | **Consequence** | **Risk factor** | <table>
| --- | --- | --- | --- | <tr>
| Project delay | 3 | 2 | 6 | <td>
| Late delivery | 2 | 5 | 10 |
| Delivery of unfinished product | 2 | 5 | 10 | **<span dir="">What</span>**
| Loss of work | 1 | 4 | 4 | </td>
| Server downtime | 1 | 2 | 2 | <td>
**<span dir="">Probability</span>**
</td>
<td>
**<span dir="">Consequence</span>**
</td>
<td>
**<span dir="">Risk factor</span>**
</td>
</tr>
<tr>
<td>
<span dir="">Project delay</span>
</td>
<td>
<span dir="">3</span>
</td>
<td>
<span dir="">2</span>
</td>
<td>
<span dir="">6</span>
</td>
</tr>
<tr>
<td>
<span dir="">Late delivery</span>
</td>
<td>
<span dir="">2</span>
</td>
<td>
<span dir="">5</span>
</td>
<td>
<span dir="">10</span>
</td>
</tr>
<tr>
<td>
<span dir="">Delivery of unfinished product</span>
</td>
<td>
<span dir="">2</span>
</td>
<td>
<span dir="">5</span>
</td>
<td>
<span dir="">10</span>
</td>
</tr>
<tr>
<td>
<span dir="">Loss of work</span>
</td>
<td>
<span dir="">1</span>
</td>
<td>
<span dir="">4</span>
</td>
<td>
<span dir="">4            </span>
</td>
</tr>
<tr>
<td>
<span dir="">Server downtime</span>
</td>
<td>
<span dir="">1</span>
</td>
<td>
<span dir="">2</span>
</td>
<td>
<span dir="">2</span>
</td>
</tr>
</table>
Probability and consequence values are given on a scale of 1-5. Risk factor is probability times consequence. Probability and consequence values are given on a scale of 1-5. Risk factor is probability times consequence.
## 5.5 Installation ## 5.5 Installation
Because we use a cloud-like model where no work is being done on the user&#39;s computer, no special installation concerns are required. All users are only required to have a web browser and an internet connection. Because we use a cloud-like model where no work is being done on the user's computer, no special installation concerns are required. All users are only required to have a web browser and an internet connection.
The actual software will be built in JavaScript on top of the node.js and React frameworks. These tools will be required on the server for building and running the project. The basic mechanics will build on tools and techniques used in our earlier programming courses. The actual software will be built in JavaScript on top of the node.js and React frameworks. These tools will be required on the server for building and running the project. The basic mechanics will build on tools and techniques used in our earlier programming courses.
@ -327,7 +414,7 @@ The software should be accessible through a normal web browser. The user will be
## 6.2 User management ## 6.2 User management
Our customer has two levels of administrator access, &quot;Administrators&quot; and &quot;Management&quot;. Users in the management group should be able to access and modify all tournaments in the system, as well as creating or removing administrators. Our customer has two levels of administrator access, "Administrators" and "Management". Users in the management group should be able to access and modify all tournaments in the system, as well as creating or removing administrators.
## 6.3 Easy Collaboration ## 6.3 Easy Collaboration
@ -356,23 +443,21 @@ Usability is an important aspect of modern web development. By sticking to estab
# 9 Precedence and Priority # 9 Precedence and Priority
Here we have listed different system features and prioritized them. Here we have listed different system features and prioritized them.
| **Feature** | **Priority** | **Precedence** | | **Feature** | **Priority** | **Precedence** |
| --- | --- | --- | |-------------|--------------|----------------|
| Intuitive Web Interface | 3 | Intuitive Web Interface is the most important feature of the program, and it precedes any other, because unless the interface is intuitive there is little reason to improve on other areas. | | Intuitive Web Interface | 3 | Intuitive Web Interface is the most important feature of the program, and it precedes any other, because unless the interface is intuitive there is little reason to improve on other areas. |
| User Management | 3 | User management should be one of the core features of the program to ensure easy access and usage, | | User Management | 3 | User management should be one of the core features of the program to ensure easy access and usage, |
| Automatic Bracketing | 2 | Automatic Bracketing is a Quality-of-Life improvement which reduces the amount of effort and clicking needed by the end user to set up a bracket. With just simple inputs of names and teams, the system will create a bracket on its own without the need of an end user moving slots around and manually assigning each slot with a name. | | Automatic Bracketing | 2 | Automatic Bracketing is a Quality-of-Life improvement which reduces the amount of effort and clicking needed by the end user to set up a bracket. With just simple inputs of names and teams, the system will create a bracket on its own without the need of an end user moving slots around and manually assigning each slot with a name. |
| Easy Collaboration | 1 | Easy Collaboration by multiple administrators is a &quot;nice to have&quot; feature, but it is more important to improve the workflow of each administrator rather than allowing multiple administrators to enter the workflow. Therefore, it is preceded by scheduling. | | Easy Collaboration | 1 | Easy Collaboration by multiple administrators is a "nice to have" feature, but it is more important to improve the workflow of each administrator rather than allowing multiple administrators to enter the workflow. Therefore, it is preceded by scheduling. |
| Scheduling | 1 | Scheduling of when and where precedes easy collaboration, as its more important to have a functioning system where everyone is able to view the correct info, rather than having multiple people being able to edit and manage a single tournament. | | Scheduling | 1 | Scheduling of when and where precedes easy collaboration, as its more important to have a functioning system where everyone is able to view the correct info, rather than having multiple people being able to edit and manage a single tournament. |
Priority values are given on a scale of 1-3. Priority values are given on a scale of 1-3. Precedence compares the features with the same priority and ranks them accordingly within the priority range.
Precedence compares the features with the same priority and ranks them accordingly within the priority range.
# 10 Other Product Requirements # 10 Other Product Requirements
## 10.1 Applicable Standards ## 10.1 Applicable Standards
WCAG 2.1[1] WCAG 2.1\[1\]
The system should work on any platform, including Windows and \*NIX-based Operating Systems The system should work on any platform, including Windows and \*NIX-based Operating Systems