srs intelligentquizmaster

11
SRS for Intelligent Quiz Master 1 Software Requirements Specification for Intelligent Quiz Master Version 1.0 Prepared by: Group 34 Members: Akanksha Kumawat (Y12UC021) Akshat Kumar (Y12UC024) Ekshit Nalwaya (Y12UC087) Parag Saxena (Y12UC173) Yashvardhan (Y12UC297)

Upload: yash-vardhan

Post on 13-Sep-2015

213 views

Category:

Documents


0 download

DESCRIPTION

An intelligent quiz master

TRANSCRIPT

  • SRS for Intelligent Quiz Master

    1

    Software Requirements

    Specification

    for

    Intelligent Quiz Master

    Version 1.0

    Prepared by: Group 34

    Members:

    Akanksha Kumawat (Y12UC021)

    Akshat Kumar (Y12UC024)

    Ekshit Nalwaya (Y12UC087)

    Parag Saxena (Y12UC173)

    Yashvardhan (Y12UC297)

  • SRS for Intelligent Quiz Master

    2

    Table of Contents

    Table of Contents ........................................................................................................................... 2

    Revision History ............................................................................................................................. 2

    1. Introduction ............................................................................................................................. 3

    1.1 Purpose ............................................................................................................................ 3

    1.2 Document Conventions ................................................................................................... 3

    1.3 Intended Audience and Reading Suggestions ................................................................. 3

    1.4 Product Scope .................................................................................................................. 3

    1.5 References ....................................................................................................................... 4

    2. Overall Description .................................................................................................................. 4

    2.1 Product Perspective ......................................................................................................... 4

    2.2 Product Functions ............................................................................................................ 6

    2.3 User Classes and Characteristics ..................................................................................... 6

    2.4 Operating Environment ................................................................................................... 6

    2.5 Design and Implementation Constraints .......................................................................... 6

    2.6 User Documentation ........................................................................................................ 7

    2.7 Assumptions and Dependencies ...................................................................................... 7

    3. External Interface Requirements ........................................................................................... 7

    3.1 User Interfaces ................................................................................................................. 7

    3.2 Hardware Interfaces ......................................................................................................... 7

    3.3 Software Interfaces .......................................................................................................... 7

    3.4 Communications Interfaces ............................................................................................. 7

    4. System Features ....................................................................................................................... 8

    4.1 Take a Self Quiz .............................................................................................................. 8

    4.2 Define and conduct quizes ............................................................................................... 8

    4.3 Register and participate in the quiz ................................................................................. 9

    5. Other Nonfunctional Requirements ..................................................................................... 10

    5.1 Performance Requirements ............................................................................................ 10

    5.2 Safety Requirements ...................................................................................................... 10

    5.3 Security Requirements ................................................................................................... 10

    5.4 Other Software Quality Attributes ................................................................................. 10

    6. Other Requirements .............................................................................................................. 11

    Appendix A: Glossary ................................................................................................................. 11

    Appendix B: Analysis Models ..................................................................................................... 11

    Appendix C: To Be Determined List ......................................................................................... 11

    Revision History

    Name Date Reason For Changes Version

    Group 34 7th February 2015 Initial Preparation V 1.0

  • SRS for Intelligent Quiz Master

    3

    1. Introduction

    1.1 Purpose

    This software package is developed from scratch to develop a quiz master, that

    Allow moderators to conduct quizzes by providing a joint interface for multiple teams to participate together.

    Letting the Moderators to maintain the question database, and the quiz rules. Allows generic users to have a random general quiz, which automatically

    adapts to their preferences, knowledge. Maintain users individual score. Allow users to participate in a quiz conducted by moderators.

    1.2 Document Conventions

    The following documentation conventions are followed in preparing this SRS:

    The priority of a requirement is specified at the end of that requirement using the notation Priority: nn, where nn is an integer in the range 00 (lowest priority) to 99 (highest priority).

    1.3 Intended Audience and Reading Suggestions

    This document is created for

    Various organizations who conduct quizzes with multiple teams participating simultaneously on a local area network.

    General users who want to take casual self-quiz and/or want to participate in quizzes conducted by others.

    The software development team for their use in analysing the requirements.

    1.4 Product Scope

    The scope of the to-be-developed Intelligent Quiz Master software package is:

    To enable the general end users to use this as a general self-quiz, which maintains their score and adapts itself to provide adequate challenge to the

    users. To enable participants to participate in quizzes conducted by moderators. To enable organizations to use this as a replacement for manual quizzes and

    provide a better, secure and an automated interface to conduct quizzes among

    multiple participants.

  • SRS for Intelligent Quiz Master

    4

    1.5 References

    http://io.acad.athabascau.ca/~oscarl/pub/edutainment.pdf

    https://www.facebook.com/SmartQuizMasterBhandul

    http://the-britannica-quizmaster.software.informer.com/

    2. Overall Description

    2.1 Product Perspective

    This product is a new, self-contained product which intends to replace the present

    manual way of conducting Quizzes.

    The Quiz Master functions Part I: Conducting a new quiz:

    Start

    Stop

    S1 S2 S3

    Validation of the

    fields

    Creation of a

    new quiz and/or

    deletion of an

    existing quiz by

    an authorized

    moderator

    Creating the

    quiz and

    generating the

    registration link

  • SRS for Intelligent Quiz Master

    5

    The Quiz Master Functions Part II: Registering for an upcoming quiz:

    The General User Functions: Playing a quiz

    Start

    Stop

    Stop

    S1 S2 S3

    S4

    C1

    Validate and check for availability

    Register for a quiz

    using the provided

    link

    Decide if entries are available

    Register the

    participant and

    provide username,

    password and the

    quiz link

    yes

    no

    Reject and

    close the

    registration

    screen

    Start

    Stop

    S1 S2

    S4

    C1

    Start the quiz

    User quits

    Ask question and

    wait for user

    response.

    no

    yes

    S3

    Compute the score

    and display to the

    user

    Evaluate the user

    response and prepare the

    next question.

  • SRS for Intelligent Quiz Master

    6

    2.2 Product Functions

    This software package is expected to offer the following services:

    For Moderators: o Facility to conduct quizzes with multiple participants. o Facility to maintain the questions database. Facility to define and maintain

    the process flow and eligibility rules of each quiz.

    o Facility to keep track of all the participants scores.

    For End Users: o Facility to participate in quizzes conducted by others. o Facility to take self-quiz and monitor their own progress.

    2.3 User Classes and Characteristics

    This software package will be used by three categories of users:

    Quiz moderators: These users will use this software package to define, modify and conduct quizzes at any given time on a local area network.

    Participants: They will use the software package to register themselves and to participate in quizzes being conducted by moderators at any given time.

    General users: They will use the software package as a self-assessment quiz and monitor their own progress.

    2.4 Operating Environment

    This software package is accepted to work in the following atmosphere:

    Microsoft Stack consisting of o MS Windows Vista and higher versions based thin client

    o C++

    o Visual Studio

    o Apache HTTP Server 2.2 and higher

    2.5 Design and Implementation Constraints This software package will not carry over the details of the participants of the

    previous quizzes, i.e., new entries for each participants taking the quiz is

    mandatory.

    This software package allows simultaneous connection of up to four participating teams, provided they are all connected on a local area network.

    Registrations of participants for a particular quiz will be made on a first come first serve basis. No new registration will be made after four entries have

    already been made.

    There will be no connectivity provided with the internet.

    In case a registered team does not enter the quiz it will be automatically disqualified from the quiz.

    In case no team shows up then the quiz will be considered as dropped.

  • SRS for Intelligent Quiz Master

    7

    2.6 User Documentation Video tutorials for this software package will be provided on the internet for

    each of the three types of users.

    This software package will come with an user manual on how to use the facilities available for the different types of users.

    The details of the Analysis, Design, and Test Cases of this software package will be delivered along with this software.

    2.7 Assumptions and Dependencies Assumptions: All the participants are required to have this software package in

    order to participate in the quiz. Dependencies: Boost(Third party Library for C++ programming Language) will

    be used.

    3. External Interface Requirements

    3.1 User Interfaces To take a Self-quiz and check the score. To register in an upcoming Quiz. To enter in an ongoing quiz. To login as a moderator.

    o To schedule and conduct a new quiz. o To monitor the ongoing quiz. o To maintain a question database. o To view the details of all the past quizzes

    3.2 Hardware Interfaces

    Nil

    3.3 Software Interfaces

    This software package should have an interface with:

    The question database stored in a XML file.

    The scoreboard and quiz history stored in a XML file.

    Boost Libraries

    3.4 Communications Interfaces

    The clients will connect to the server through TCP ports.

    Data will be exchanged through packets transferred over FTP protocol.

    Synchronous connection will be stabilised between the client and the server, tracked with accurate timestamps.

    In case of high latency or communication error the server will halt till the issue is fixed.

  • SRS for Intelligent Quiz Master

    8

    4. System Features

    The requirements of this software package are described per each category of User:

    All requirements of the Quiz Moderators All requirements of the Quiz Participants All requirements of the General Users

    Business Use Case # 1: All the Requirements of the General User:

    4.1 Take a Self-Quiz

    4.1.1 Description and Priority

    The TBD (to-be-developed) software package should facilitate the General User

    to,

    Take a self-quiz View score

    The priority of this requirement is 99.

    4.1.2 Stimulus/Response Sequences

    Sr No Stimulus from the User Response from the Software 1 The User starts the quiz Depending upon the previous

    records the software stars the quiz and ask the first question;

    2 The user selects an option Depending on the answer the software informs whether the selected option is correct or not and ask the next question;

    3 The User chooses to quit the quiz The software ends the quiz compute the final score and display it to the user;

  • SRS for Intelligent Quiz Master

    9

    Business Use Case # 2: All the Requirements of the Moderators:

    4.2 Define and Conduct Quizzes

    4.2.1 Description and Priority

    The TBD (to-be-developed) software package should facilitate the Moderators to,

    Define and conduct a new quiz, its associated process flow and eligibility rules, underwriting rules and approval rules.

    Cancel the upcoming quiz. Modify the question database. Monitor an ongoing quiz and authority to disqualify any team. View the past scoreboard and the entire quiz history.

    The priority of this requirement is 90.

    4.2.2 Stimulus/Response Sequences

    Sr No Stimulus from the User Response from the Software 1 Moderators logs-in using user-id

    and password Software will validate the user-id and password; Software will display the Quiz Master Initial Screen by recognizing the user-id;

    2 Moderator chooses the Conduct a New Quiz option

    The software will display the form to enter the details of the new quiz and all the associated rule-sets;

    3 Moderator will enter all the fields of the new quiz and also will enter all the associated rule-sets

    Software will validate all the fields and generate the link through which participates will be able to register for the quiz;

    4 The Moderator can choose to modify the database by supplying an XML file

    Depending on the outcome the software will print either Imported Successfully OR Imported Unsuccessfully;

    5 Moderator can choose to monitor an ongoing quiz

    Software will display the scoreboard along with the questions that have been asked and their responses that have been entered;

    Business Use Case # 3: All the Requirements of the Participants:

    4.3 Register and participate in the quiz

    4.3.1 Description and Priority

    The TBD (to-be-developed) software package should facilitate the Moderators to,

    Register in an upcoming quiz. Participate in an ongoing quiz. View the final result.

    The priority of this requirement is 80.

  • SRS for Intelligent Quiz Master

    10

    4.3.2 Stimulus/Response Sequences

    Sr No Stimulus from the User Response from the Software 1 The Participants registers for the

    quiz using the provided link The software validates the link if the link is valid it checks for availability, if available it registers the participant and provide a username and password;

    2 The participant logs-in to an ongoing quiz by providing its username and password along with the contest link

    The software will validate the username, password, and link, upon recognizing the software will display the quiz lobby;

    Other Stimuli and responses are described in table 4.1.2.

    5. Other Non-functional Requirements

    5.1 Performance Requirements Each transaction (situation-response case), on an average taken for a duration of

    100 hours or till 1000 transactions are successfully completed, should have a turn-

    around time of less than 5 seconds under the following load on the software: There are 5 users accessing this software at a given time. There are 10,000 questions in the database.

    5.2 Safety Requirements

    The network system and the connection will not be vulnerable to spam and DDoS attacks.

    Synchronous connections between the clients and the server will be maintained.

    In case of file corruption, a backup of the question database will be provided to the moderators.

    5.3 Security Requirements This software package should: Authenticate each moderator who logs-in.

    Authenticate each registered participants for an ongoing quiz.

    Use a 64 bit key to encrypt all the questions and responses transferred to and from the thin client and the server; similarly, encrypt all the questions that is

    stored in the XML files.

    5.4 Software Quality Attributes Nil

  • SRS for Intelligent Quiz Master

    11

    6. Other Requirements

    Nil

    Appendix A: Glossary

    Visual Studio: Microsoft Visual Studio is an integrated development environment (IDE) from Microsoft. It is used to develop computer programs for Microsoft Windows, as well

    as web sites, web applications and web services. Visual Studio uses Microsoft software

    development platforms such as Windows API, Windows Forms, Windows Presentation

    Foundation, Windows Store and Microsoft Silverlight. It can produce both native

    code and managed code.

    DDoS Attacks: A denial-of-service (DoS) or distributed denial-of-service (DDoS) attack is an attempt to make a machine or network resource unavailable to its intended users.

    XML File: Extensible Markup Language (XML) is a markup language that defines a set of rules for encoding documents in a format which is both human-readable and machine-

    readable. It is defined by the W3C's XML 1.0 Specification and by several other related

    specifications, all of which are free open standards.