game-based learning system system …home.hit.no/~152465/sd.pdfsystem documentation system...

System documentation

Game-based Learning System

System documentation

Ver. < 1.1 >

System documentation Table of Contents

Table of Contents

Preface ....................................................................................................................................... 3

1. Overview ............................................................................................................................. 4

Glossary ...................................................................................................................................... 4

1.1. Introduction .................................................................................................................... 4

1.2. Description ...................................................................................................................... 4

2. User Requirements Definition ............................................................................................ 4

3. System Architecture ........................................................................................................... 5

3.1. Class Diagram .................................................................................................................. 5

3.2. Sequence Diagram Logged-in User ................................................................................. 6

3.3. Sequence Diagram Create User ...................................................................................... 7

3.4. UseCase Diagram ............................................................................................................ 8

3.5. Graphical User Interface Specification ......................................................................... 10

4. System Requirements Specification ................................................................................. 11

5. System Models ................................................................................................................. 13

6. Installation Guide.............................................................................................................. 14

6.1. Client installation .......................................................................................................... 14

6.2. Server installation ......................................................................................................... 14

7. System Maintenance ........................................................................................................ 15

7.1. Visual Studio Code ........................................................................................................ 15

7.2. SQL Server Code ............................................................................................................ 15

8. Further System Evolution ................................................................................................. 16

System documentation Preface

Group 2 – Systemdevelopment and documentation 3

Preface

This document was created to describe the software DOON that we’ve made for the

customers Olav Dæhli and Hans Petter Halvorsen.

Table 1: Shows document version history.

Version number Commentary Changes made

1.0 Draft of System document

with titles and text in correct

format.

Titles added.

Texts added.

Figures and tables

created.

1.1 Added Preface.

Figures updated.

Added Installation Guide.

Spellchecked every

Chapter.

Removed and

updated cross-

references.

Inserted Captions.

Changed format for

introducing Tables.

Added Staff and

Version history in

preface.

Figures updated

include sequence

diagrams, class

diagrams and

models.

Added steps for

guide.

Table 2: Shows current staff and contact information.

Name Email Cell# Role

Nilsen, Casper [email protected] 41603998 Systems

Engineer

Heldal, Sander [email protected] 98687242 Systems

Engineer

Torsdal, Martin [email protected] 41347997 Systems

Engineer

Larsen, Kenneth [email protected] 92428045 Systems

Engineer

System documentation Preface, Glossary, Introduction, Description and URD


1. Overview

Glossary

GUI - Graphical User Interface

1.1. Introduction

DOON is a Game-based Learning System that lets a user create, share and play quizzes.

With DOON one will be able to make and take customized quizzes by creating a user on

the website. The different quizzes will be saved in a database for quick retrieval and the

user will have the option to publish the quizzes online so that other users can participate.

When a user has finished a quiz, the user can view the results where their done quizzes

are located. DOON is to be used for educational and entertainment purposes.

1.2. Description

DOON is made for different web browsers and uses primarily Visual Studio 2015

Enterprise Edition with communication with SQL Server 2014. Microsoft azure hosts the

website in the cloud so server-side installation is unnecessary. The web address

Doon.Azurewebsites.net is the main website for DOON. Here one can do all the things

described in the introduction. With communication between the website and the

database, the different users, quizzes and results are sorted in the database server in SQL.

2. User Requirements Definition

With DOON you can participate in a quiz through the internet browser on your

computer. When you enter the homepage of DOON you can log in or create a user so

that you can join a quiz or make a quiz. When you are making your own quiz, you can

choose how many questions the quiz will have and the questions/answers. You can then

choose how long the quiz will be open, a few hours or days. Then you can save the quiz

for later uses or publish it right away, this means you can also load an already saved

quiz.

When a quiz is created, you are appointed a Quiz-code that works like a gateway to do

your quiz. At the homepage, a user can click on "join game" and enter your code to join

the quiz. Here that user can see the questions and choose their answers, then submit the

quiz. When the timer for the quiz is over each user can see their results.

System documentation System Architecture


3. System Architecture

3.1. Class Diagram

Figure 3.1-1: Class Diagram shows the systems current class diagram.

Figure 3.1-1: Class Diagram



3.2. Sequence Diagram Logged-in User

Figure 3.2-1 : Sequence Diagram shows the systems Logged-in User sequence

diagram.

Figure 3.2-1 : Sequence Diagram Logged-in user



3.3. Sequence Diagram Create User

Figure 3.3-1: Sequence Diagram Create User shows the systems Create User current

sequence diagram.

Figure 3.3-1: Sequence Diagram Create User



3.4. UseCase Diagram

Figure 3.4-1: Use Case Diagram 1 and Figure 3.4-2: Use Case Diagram 2 shows the two

use cases used for designing the system.

Figure 3.4-1: Use Case Diagram 1



Figure 3.4-2: Use Case Diagram 2



3.5. Graphical User Interface Specification

Figure 3.5-1 Graphical User Interface shows a technical GUI layout for the website.

Figure 3.5-1 Graphical User Interface

System documentation System Requirements Specification


4. System Requirements Specification

Table 3: Shows functional Requirements.

Req

#

Requirement Comment Priority

Date

rvwd

Approve

dby

1 You must be able to create and

participate in a quiz.

1 30.01

2 The software must function on

a computer.

1 30.01

3 The software must work on

most browsers.

1 30.01

4 One must be able to create and

log into personal users.

1 30.01

5 One must be able to save, load

and customize a quiz.

1 30.01

6 One must be able to share a

quiz.

Via email?

Username?

2 30.01

7 The questions must have four

alternatives.

Will try to develop

new features.

1 30.01

System documentation System Requirements Specification


Table 4: Shows the Non-functional Requirements.

1 The software must be

accessible online.

Local at first.

Web Address

necessary.

2 30.01

2 User data must be secure. No leak from SQL

Server.

Decryption?

1 30.01

3 Quiz participants must not gain

quizmaster rights.

1 30.01

4 The program must not freeze

or stop its function.

1 30.01

5 Database connection errors

must not affect program

performance.

3 30.01

6 There must be no superfluous

buttons, textboxes, figures or

tables.

i.e. no button should

do nothing.

3 30.01

7 Quiz-Code system must work. 3 30.01

8 Lobby join and create must

work.

4 30.01

System documentation System Models


5. System Models

Figure 5-1: Flow Chart shows a flow chart of the process through the website.

Figure 5-1: Flow Chart

System documentation Installation Guide


6. Installation Guide

6.1. Client installation

There are no client installations required for DOON to work. Any end-user can visit the

website and all features will be available.

However, if the client wishes to develop the system further, these are the instructions

explaining how to do so:

Software Requirements:

Windows 10 running on desktop or laptop computer.

Visual studio Enterprise 2015 with update 3.

SQL Server 2014 recommended.

Web Browser (Google Chrome recommended).

Follow these steps to start an edit of the code:

1. Install Software.

2. Run SQL Server 2014 and connect to the server with the server name, login info and

password. If you have not received this login information please contact Table 2: Shows

current staff and contact information.

Please provide the IP address of the computer you wish to access the database on

otherwise azure’s servers will not give you permission to access the database.

3. If the Database has no tables or stored procedures, run the Database script in a query

in SQL Server, the script’s location is “Gruppe 2\Database\DOONDatabaseScript.sql”.

4. Open the Visual Studio Solution located in

“Gruppe 2\Code\Web\WebQuiz\WebQuiz.sln”.

5. In solution Explorer, select your web form and start editing.

6. To Publish changes to website, locate the publish settings under “gruppe 2\doon-

1.publishSettings” and publish with those settings.

For any questions regarding development of the software please contact the staff by

email.

6.2. Server installation

There are no Server installations required for DOON to work as it runs in the cloud on

the azure website.

System documentation System Maintenance


7. System Maintenance

In this chapter, there will be useful information for maintenance, changes or additional

development that needs to be made to DOON. For the information described below it is

assumed that the administrator of the DOON program has access to the complete Gruppe

2 folder containing the entirety of the DOON quiz program.

7.1. Visual Studio Code

When developing DOON from Visual Studio one must first follow the steps described

under Client installation. The Visual Studio code contains 8 web forms including the

front-page form. There is a stylesheet.css file that sets the style of some of the GUI in all

the forms. There are 7 classes grouped in the “Classes” folder and 6 interfaces that are

grouped in the “Interfaces” folder. All the different classes except for Database.cs inherit

from their own respective interface. On normal run the program starts

FrontPageForm.aspx, if this page is not set as start page please do so before debugging.

7.2. SQL Server Code

The SQL Server code contains 5 tables that are located at QuizDatabase\Tables. There

are 23 stored procedures used to get and set data in the database and they are in.

System documentation Further System Evolution


8. Further System Evolution

The team will try to develop the system for future versions which may or may not have

any of the following features:

Comprehensive quiz sharing.

When a quiz is shared, the user receiving the quiz could be able to edit the quiz together

with the creator. This would give each question of the quiz more variety and make the

quiz much faster to finish creating.

Online lobby system.

Where multiple users join a lobby to participate in a quiz simultaneously live. The users

are sorted and are open to chat in the quiz chatroom, if they are logged in on the website

they will have the option to add other users or open private chatrooms.

Different types of quizzes.

Where regular quizzes are only text-based or where one must cross out from a set of

alternatives there are other ways to have quizzes. The application could use game-

quizzes where participants must select the right image, type in the right letters, click a

certain amount of times and many other different kinds of quizzes.

game-based learning system system …home.hit.no/~152465/sd.pdfsystem documentation system...

Documents