Social Gaming Network. Software Engineering I Dr Mahmoud Elish Requirements Engineering Report

Transcription

1 Social Gaming Network Software Engineering I Dr Mahmoud Elish Requirements Engineering Report By Ahmad Al-Fulaij 9922 Osama Al-Jassar Saud Al-Awadhi

2 Table of Contents 1. Vision Document Introduction Purpose Scope Definitions, Acronyms, and Abbreviations References Overview Positioning Business Opportunity Problem Statement Product Position Statement Stakeholder and User Descriptions Stakeholder Description User Summary Key Stakeholder/User Needs Alternatives and Competition Product Overview Product Perspective Assumptions and Dependencies Product Features Appendix I Feature Attributes Status Benefit Effort Risk Stability 12 2

3 1.6.6 Target Release Assigned To Reason Use Case Modelling Use Case Documentation Use Case 1 Viewing Game Information and Progress Use Case 2 Adding Game Use Case 3 Updating Game Progress Use Case 4 Viewing Achievements Use Case 5 Chatting and Forums Use Case 6 Commenting/Reviews Use Case 7 Viewing Leaderboards Use Case 8 Logging In Use Case 9 Register Use Case 10 Comparing Progress Use Case Diagram Nonfunctional Requirements Usability Performance Reliability Maintainability State Transition Diagrams Use Case Use Case Use Case Use Case Use Case Use Case Use Case Use Case Use Case Use Case Interaction Diagrams Use Case Use Case Use Case Use Case Use Case Use Case Use Case

4 5.8 Use Case Use Case Use Case Paper Prototype Homepage Account Add Game Compare Progress Leaderboards Chat Reviews Forum 56 4

5 1. Vision Document Version <1.5> ReVision document History Date Version Description Author 14/10/ Completed most of the document details Osama, Ahmad, Saud 18/10/ First Draft Completed Osama, Ahmad, Saud 22/10/ Final Draft Completed Osama, Ahmad, Saud 22/12/ Post-Revision Osama, Ahmad, Saud 1.1 Introduction The purpose of this document is to collect, analyze, and define high-level needs and features of the SGN (Social Gaming network) and focuses on the capabilities needed by the stakeholders, and the target users, and why these needs exists. The details of how the SGN fulfils these needs are detailed in the use-case and supplementary specifications Purpose To clarify to the stakeholders the unmet needs of the users for an all-inclusive social gaming network and to outline the key costs in terms of time effort and resources to apply the features necessary to meet the user's dynamic needs, as well as exploring the business opportunities present in the venture Scope First and most important is to include video game enthusiasts of all kinds whether casual or hardcore, stakeholders,gaming developers, video game critics, reviewers and possibility of partnering with associated E-sports communities Definitions, Acronyms, and Abbreviations SGN = Social Gaming Network 5

6 Player = User = Gamer = any potential member of SGN website References is the website with a competing consumer demographic that we are trying to outperform with adding special features that it lacks is one of the partnering features that we want to integrate to our SGN, it is a video game steaming platform that is widely popular within the gaming community and we believe that it give us the upper hand in this market Overview The vision document will begin by how our position is based on the business opportunity that this website provide as well as the need for such a product as well as where we stand for our stakeholders and users. The document will also define and outline potential and probable stakeholders and users as well as listing the needs of both stakeholder and user, and detailing our prime competitors. The vision document will also provide an overview as to the key features, needs, and assumptions relevant to the success of our SGN website 1.2 Positioning Business Opportunity The business opportunity presented by our project is the tapping into the market of social video gaming, which has slowly became more prominent in the gaming community. By grouping all video gamers, into ta central location, like our website, we will be able to maximize the generation of revenue from our visitors. Other business opportunities are also present in the services we can provide in the form of subscription to our website. 6

7 1.2.2 Problem Statement The problem of affects the impact of which is a successful solution would be The lack of a single social gaming platform Player, Video game developers A division of players on the basis of platform, as well as a decreased social presence for these players among which have friends or family who may not have the same gaming devices. -The creation of the social gaming website allows players to share their video game history and information -players will be able to view leader-board to see who played the most and create a friendly competition between players -players could chat with each others and discuss about the gaming experience 7

8 1.2.3 Product Position Statement For Who The (product name) That Unlike Our product Gamers Are in need of a social media platform which focuses on bringing players together, new and old Website Provides a multitude of services, some of which are: a single location to connect friends and family who play video games, provide means by which players can find new people who share their interest, and deliver a fun, engaging experience which rewards players on their progress. Video Game Tracker Create a social media interface with competitive experience 2

9 1.3 Stakeholder and User Descriptions Stakeholder Description The product developers. Potential investors affiliated video game companies video game developers User Summary video game players video game developers video game reviewers 3

10 1.3.3 Key Stakeholder/User Needs Need Priority Concerns Current Solution Proposed Solutions To create a social gaming interface High Players and stakeholders Facebook and such but unspecialized Create our own gaming social network Provide an engaging user experience for players to have fun sharing their game history. High Players Playstation Network, Xbox Live Implementation of progress tracker as well as other features to provide adequate entertainment for our users. The need to track and share the progress and video game information of participants in an appealing manner. High Players and stakeholders Video Game Tracker A database which can store this relevant information and then be able to present it in an organized fashion Alternatives and Competition Video Game Tracker 4

11 1.4 Product Overview Product Perspective The website will be compared with PlayStation network as well as Xbox live and steam network databases please refer to section 5 features. The system is dependent on several components such as specific APIs and incorporate Google / YouTube / video game live streaming websites. Customer Benefit New support staff can quickly get up to speed. Customer satisfaction is improved because nothing falls through the cracks. Management can identify problem areas and gauge staff workload. Distributed support teams can work together to solve problems. Customers can help themselves, lowering support costs and improving response time. Customer Support System Supporting Features Knowledge base assists support personnel in quickly identifying known fixes and workarounds Problems are uniquely itemized, classified and tracked throughout the resolution process. Automatic notification occurs for any aging issues. Trend and distribution reports allow high level review of problem status. Replication server allows current database information to be shared across the enterprise Knowledge base can be made available over the Internet. Includes hypertext search capabilities and graphical query engine Assumptions and Dependencies We are dependent on certain things. The implementation of Twitch TV in our website We are dependent on progress system / tracker as the main point The ability to share progress with players dynamically A server that can handle the requests in and out access 5

12 We assume that if we are unable to implement twitch TV we would find an alternative or change the vision document slightly, we are very dependent on the progress tracker and failing to implement it will cause a delay to the website. 1.5 Product Features Feature Table Progress tracker The ability for a player to track his own progress. Progress comparison The ability for a player to compare his progress with other players progress. Chat system The ability for the players to communicate with each others. Leader-boards A dynamic list that shows the top players on a certain page. Achievements A trophy system that rewards the player with trophies by his/her progress Comment and review A player can comment or review on a certain game Feature No. Feature Description Status Benefit Effort Risk Stability Target Release 1 Progress Tracker 2 Progress Comparison Approved Critical High Medium Medium 1.0 Approved Critical Medium Medium Medium Chat system Approved Useful High High Medium Leaderboards Approved Important Medium Low Medium Achievements Approved Important Medium Medium Medium Comment and review Approved Useful High Medium Medium 1.0 6

13 1.6 Appendix I Feature Attributes Status Benefit Proposed Approved Incorporated Features that are under discussion but have not yet been reviewed and accepted by the team members. Capabilities that are deemed useful and feasible and have been approved for implementation by the team members. Features incorporated into the product baseline at a specific point in time. Critical Important Useful Indispensable, the feature is needed for the system to work. Needed feature but can be added in the next releases. Nice to have features Effort High Medium Low There is a lot of work involved. There isn t lot of work involved. There is little work involved Risk High Medium Low There is a high risk of bugs or the feature might fail. There is a medium risk of bugs or the feature might fail. There is a little risk of bugs or the feature might fail. 7

14 1.6.5 Stability High Medium Low There is a high chance that the feature might change. There is a medium chance that the feature might change. There is a low chance that the feature might change Target Release SGN v1.0 Progress Tracker Progress Comparison Chat System Comment And Review Leaderboards Achievement System Assigned To Ahmad Alfulaij assigned to Progress Tracker,Chat System Saud Al-Awadhi assigned to Progress Comparison, Leaderboards Osama Aljassar Assigned to Comment and Review, achievement System Reason Progress tracker So that a player can track his own progress. Progress comparison So that a player can compare his progress with other players progress. Chat system So that players can communicate with each other. Leader-boards So that players can see a dynamic list that shows the top players on a certain page. Achievements So that players can be awarded trophies by his/her progress 8

15 Comment and review So a player can comment or review on a certain game 9

16 2. Use Case Modeling 2.1 Use Case Documentation Use Case 1 Viewing Game Information and Progress Use Case Number 1 Use Case Name Viewing game information and progress Author/Source Ahmad Al-Fulaij Date of Creation 24/10/2015 Precondition(s) User must be logged in and the menu screen is open Successful Post Condition The user will be able to view his/her progress information and the information of a specific game that the user played Actors User Priority Critical Related Use Cases Updating game progress, logging in Flow of Events Main Flow User Action System Response UA1 User clicks on a view progress button SR1 System displays general information about the user(display name, total hours played, total games finished, total games played, total games perfected), under it the system shows general information associated with the game. Alt1:List is empty UA2 user selects a certain game on the list SR2 System opens a windows with the information about the game with the user progress information Alternative l: List is Empty User Action System Response A1.UA1 A1.SR1 System displays a massage saying: There is no games in your list, start by add a game in your list 10

17 2.1.2 Use Case 2 Adding Game Use Case Number 2 Use Case Name Adding game Author/Source Osama Aljassar Date of Creation 23/10/2015 Precondition(s) The user must be logged in Successful Post Condition The user successfully added a game to his list Actors User, Database Priority Critical Related Use Cases logging in Flow of Events Main Flow User Action System Response UA1 User clicks on add game button SR1 System opens a window and promote the user with a search bar. Alt1: clear UA2 User enters the name of the game in the search bar SR2 System show the result of the search in a list UA3 User clicks on the desired game SR3 System opens a window with two options(add, Cancel) UA4 User clicks on Add SR4 System adds the game in the user's game list and open a window for the user to enter the progress Alt2:Cancel UA5 User enters the progress information (times completed, hours played, and times perfected) then clicks on the confirm button SR5 System saves the information Alt2:Cancel Alternative l: Clear User Action System Response A1.UA1 User click on the clear button A1.SR1 System clears the text in the search bar Alternative 2: Cancel User Action System Response A2.UA1 User clicks on cancel A2.SR1 System returns to the previous windo 11

18 2.1.3 Use Case 3 Updating Game Progress Use Case Number 3 Use Case Name Updating game progress Author/Source Osama Aljassar Date of Creation 24/10/2015 Precondition(s) The user must be logged in, the game information page show be opened Successful Post Condition User successfully updated the game progress information Actors User Priority Critical Related Use Cases Viewing game progress and information, logging in Flow of Events Main Flow User Action System Response UA1 User clicks on edit button SR1 System opens a window that enables the user to edit the game (hours played, times completed, times perfected) UA2 User enters the information then clicks on save button SR2 The system saves the new information and update the game information Alt1: Cancel Alternative l: Title User Action System Response A1.UA1 User click on cancel button A1.SR1 System discards the changes and returns to the previous page 12

19 2.1.4 Use Case 4 Viewing Achievements Use Case Number 4 Use Case Name Viewing Achievements Author/Source Saud Al-Awadhi Date of Creation 24/10/2015 Precondition(s) The user must be logged in, the menu windows is opened Successful Post Condition User will be able to view his achievements Actors User Priority High Related Use Cases Logging in Flow of Events Main Flow User Action System Response UA1 Users clicks on the view achievements SR1 System shows a list of achievements that the user completed and not completed(not completed achievements will be show in gray) and general information on the achievement and the total achievement progress 13

20 2.1.5 Use Case 5 Chatting and Forums Use Case Number 5 Use Case Name Chatting and Forums Author/Source Saud Al-Awadhi Date of Creation 24/10/2015 Precondition(s) User is logged in, menu windows is opened Successful Post Condition User has successfully created a chat post. Actors User Priority High Related Use Cases Logging in Flow of Events Main Flow User Action System Response UA1 User selects Forum and Reviews from the list of available services SR1 System changes page to the Forum Board main page. The user is able to select from a list of available forum UA2 UA3 User chooses from a list of available forum topics (game related or miscellaneous) The user chooses to view a sub-forum thread. 14 SR2 SR3 topics (game related or miscellaneous) System directs the user to the subforum page he has requested. System displays all related threads in this category. The user is able to view a forum thread under the sub-forum's category. ALT2: Create The system displays the selected thread body. System offers the ability to respond to the selected thread. ALT3:Respond Alternative l: Cancel User Action System Response A1.UA1 A1.SR1 The system returns to the previous page displayed. Alternative 2: Create User Action System Response A2.UA1 A2.SR1 System changes page and prompts the user to fill in the following data for his thread: Thread Title, Thread Subject, Thread Opening Body for discourse. Thread is created and User is directed to the thread's page on the forums. ALT1: Cancel

21 Alternative 3: Respond A3.UA1 A3.SR1 System opens a text dialogue for the user and adds user input to the bottom of the thread and marks the thread as Replied. ALT1:Cancel 15

22 2.1.6 Use Case 6 Commenting/Reviews Use Case Number 6 Use Case Name Commenting/Reviews Author/Source Saud Al-Awadhi Date of Creation 24/10/2015 Precondition(s) User is logged in Successful Post Condition User has successfully commented on a video game. Actors User Priority Low Related Use Cases Logging in Flow of Events Main Flow User Action System Response UA1 User selects the Forums and Reviews option from the list of available services SR1 System changes page to the Forum Board main page. The user is able to select from a list of available forum topics (game related or miscellaneous) UA2 User chooses the Review and SR2 System directs the user to the list of UA3 UA4 Comments option. The user selects the title of his desired video game. The user chooses a specific review by a certain reviewer. SR3 SR4 games. System shows the user a list of different reviews from different reviewers. System displays the review(reviewer name, review) under it the system displays comments from the users(display name, comment) Alt1: Comment Alternative l: Cancel User Action System Response A1.UA1 The user inputs his comment A1.SR1 System successfully adds comment to the Comment/Review Section of the video game. 16

23 2.1.7 Use Case 7 Viewing Leaderboards Use Case Number 7 Use Case Name Viewing leaderboard Author/Source Ahmad Alfulaij Date of Creation 24/10/2015 Precondition(s) The Main Menu window is opened Successful Post Condition The user will be able to view the leader-boar Actors User Priority High Related Use Cases Achievements,progress comparison Flow of Events Main Flow User Action System Response UA1 User clicks on the leader-board button SR1 System shows a list of users(rank, Display name, hours played) sorted by hours played(leader-board). Alt1: Empty List Alternative l: Empty List User Action System Response A1.UA1 A1.SR1 System shows a message that the leader-board is empty 17

24 2.1.8 Use Case 8 Logging In Use Case Number 8 Use Case Name Logging in Author/Source Osama Aljassar Date of Creation 23/10/2015 Precondition(s) User not logged in Successful Post Condition The user is successfully logged in Actors User Priority Critical Related Use Cases Register Flow of Events Main Flow User Action System Response UA1 User clicks on log in button SR1 System opens a window with two text field, user-name and password and log in button and register button Alt1:Cancel UA2 The user enters user-name and password then click on log in button SR2 System verifies the log in info, if correct system return to the previous page as a logged in user, else Alt2:log in failed Alternative l: Cancel User Action System Response A1.UA1 A1.SR1 Return to the previous page Alternative 2: log in failed User Action System Response A2.UA1 A2.SR1 System views an error message and lets the user to re-enter the log in information 18

25 2.1.9 Use Case 9 Register Use Case Number 9 Use Case Name Register Author/Source Osama Aljassar Date of Creation 23/10/2015 Precondition(s) User not logged in Successful Post Condition The user is successfully registered Actors User Priority Critical Related Use Cases Logging in Flow of Events Main Flow User Action System Response UA1 User clicks on register button SR1 System opens a windows with the required text fields for the user.(username, display-name, ) UA2 User clicks on register SR2 System registers the user. Alt1: Registration failed. Alt2: cancel Alternative l: Registration failed User Action System Response A1.UA1 A1.SR1 System displays an appropriate message depending on the error Alternative 2: Cancel User Action System Response A2.UA1 A2.SR1 System returns to the previous page 19

26 Use Case 10 Comparing Progress Use Case Number 10 Use Case Name Comparing progress Author/Source Ahmad Alfulaij Date of Creation 24/10/2015 Precondition(s) User must have at least one game in library and logged in Successful Post Condition The user successfully compared his progress with other user Actors User Priority High Related Use Cases Logging in Flow of Events Main Flow User Action System Response UA1 User clicks on another user's account SR1 System displays user's account along with general information about user and games he owns as well as some options UA2 User selects compare progress SR2 System displays a window with general comparison at the top of the page(hours played, games played, games completed, games perfected). Under it the system displays game by game comparison with the two users(times completed, hours played, times perfected) UA3 User selects compare achievements SR3 The system displays a windows with achievements comparison between the two players 20

27 2.2 Use Case Diagram 3. Nonfunctional Requirements 3.1 Usability: The user should learn how to be minimally productive by adding a game within 2 minutes into using the system User should be operationally productive and be able to fully use the system with 20 minutes of usage Adding a game should take between 1 to 2 minutes Comparing progress should take between 1 to 2 minutes Comparing our system with popular related systems such as game tracker, we see that a customer can learn our system 5 minute faster than the other system. 21

28 The user should be able to select a user and compare his progress within 5 minutes Creating and registering a new account should take between 3 to 4 minutes logging in should only take one minute Starting a chat with a user should take 2 to 3 minutes 3.2 Performance: When searching for a game, the system should show the result of the search in under 1 minute The system should be able to validate a user account in under 1 minute The system should be able to register the user in under 1 minute The system should be able to get two users progresses and compare them in a list within 3 minutes The system should handle the traffic of 500 users at a time The system should be able to check the user progress and update his/her achievements within 2 minutes 3.3 Reliability: The system should be available 95% of the time Mean time between failure: 1 month Mean time to repair: 3 hours 3.4 Maintainability: A developer should be able to read and understand the code within one day Adding a new feature should take a maximum of 5 days 22

29 4. State Transition Diagrams 4.1 Use Case 1 23

30 4.2 Use Case 2 24

31 4.3 Use Case 3 25

32 4.4 Use Case 4 26

33 4.5 Use Case 5 27

34 4.6 Use Case 6 28

35 4.7 Use Case 7 29

36 4.8 Use Case 8 30

37 4.9 Use Case 9 31

38 4.10 Use Case 10 32

39 5. Interaction Diagrams 5.1 Use Case 1 33

40 5.2 Use Case 2 34

41 5.3 Use Case 3 35

42 5.4 Use Case 4 36

43 5.5 Use Case 5 37

44 5.6 Use Case 6 38

45 5.7 Use Case 7 39

46 5.8 Use Case 8 40

47 5.9 Use Case 9 41

48 5.10 Use Case 10 42

49 6. Paper Prototype 6.1 Homepage 43

50 6.2 Account 44

51 6.3 Add Game 45

52 46

53 6.4 Compare Progress 47

54 Lea der boa rds

55 6.6 Chat 49

56 6.7 Reviews 50

57 6.8 Forum 51