Eloha%20view%20 srs
Upcoming SlideShare
Loading in...5
×
 

Eloha%20view%20 srs

on

  • 500 views

software requirement specification

software requirement specification

Statistics

Views

Total Views
500
Views on SlideShare
500
Embed Views
0

Actions

Likes
0
Downloads
5
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Eloha%20view%20 srs Eloha%20view%20 srs Document Transcript

    • Software Requirements Specification for Eloha View Version 1.0 approved Prepared by Raffaele Sandrini & Jona Schoch ETH Zurich 15.04.2008Copyright © 2002 by Karl E. Wiegers. Permission is granted to use, modify, and distribute this document.
    • Software Requirements Specification for Eloha View Page iiTable of Contents1. Introduction .............................................................................................................. 1 1.1 Purpose ......................................................................................................................... 1 1.2 Scope ............................................................................................................................ 1 1.3 Definitions, acronyms and abbreviations....................................................................... 1 1.4 Glossary ........................................................................................................................ 1 1.5 References .................................................................................................................... 2 1.6 Overview ....................................................................................................................... 22. Overall Description .................................................................................................. 3 2.1 Product Perspective ...................................................................................................... 3 2.2 Product Features........................................................................................................... 3 2.2.1 Supported functions .................................................................................................. 3 2.2.2 Unsupported functions .............................................................................................. 3 2.3 Operating Environment ................................................................................................. 33. Specific Requirements ............................................................................................ 4 3.1 Functionality .................................................................................................................. 4 3.1.1 Events ....................................................................................................................... 4 3.1.2 Actions....................................................................................................................... 6 3.2 Usability....................................................................................................................... 10 3.2.1 Documentation ........................................................................................................ 10 3.2.2 Language ................................................................................................................ 10 3.3 Reliability ..................................................................................................................... 11 3.3.1 Error handling.......................................................................................................... 11 3.4 Deployment ................................................................................................................. 11 3.4.1 Installation ............................................................................................................... 11 3.5 System ........................................................................................................................ 12 3.5.1 Supported Operating Systems ................................................................................ 12Revision HistoryName Date Reason For Changes Version
    • Software Requirements Specification for Eloha View Page 11. Introduction1.1 PurposeThe purpose of this document is to describe the Eloha View (EV) product with the releasenumber 0.1. The SRS contains the functional and non-functional requirements of theproject.This document contains the guidelines for the stakeholders (especially Section 2) and thedevelopers (particularly Section 3) respectively.1.2 ScopeThe EV Product is a graphical user interface, specifically designed for the use with theImplementation of the Eloha Card Game.Even though the Product is adapted to fulfill the needs of the Eloha Card Game, it may bepossible to use it as a GUI for any other card game, as long as the functionality ourproduct provides is sufficient for this kind of card game.This SRS describes only the required functionality of the EV, not the functionality ofexternal systems.1.3 Definitions, acronyms and abbreviationsTable 1 explains the terms and abbreviations used in this documentTerm / Abbreviation ExplanationSRS Software Requirement SpecificationEV Eloha ViewGUI Graphical User InterfaceSUN JRE SUN Java Runtime Environment Table 11.4 GlossaryTable 2 contains the key terms and concepts mentioned and used in this SRSWord Explanationplayer A participant of the Eloha Card Gameuser The user of the EV programcard A game card from a standard playing card decktable The playing board with the stack and the other playersstack Place where the cards which are played will be putdeck The view of a user, including his hand and buttonshand The cards of a playerslot A placeholder for a card in a hand or in the stackbutton A control which the user can activate Table 2
    • Software Requirements Specification for Eloha View Page 21.5 ReferencesThe following table defines the list of all documents referenced elsewhere in theserequirements or have been used as a source to create this SRS.Reference and Applicable Reference and VersionDocument TitleEloha Card Game https://svn.origo.ethz.ch/jid08-SRS team17/trunk/srs_team_model/Eloha_model_SRS.pdfIEEE 830-1998 http://se.inf.ethz.ch/teaching/2008-standard [IEEE-830] S/0284/exercise/project_docs_step1.zipSRS template http://www.processimpact.com/process_assets/srs_template.docSRS for the Virtual http://www.cs.utexas.edu/users/s2s/latest/pond2/doc/SRS.htmlPond project Table 31.6 OverviewChapter 2 defines the general functions of EV, the intended application and constraintswhich must be respected.Chapter 3 specifies functional (Section 3.1) and non functional requirements (all othersections), including usability, reliability and security considerations and requirements. All ofthem are described to a level of detail sufficient for designers to design a system to satisfythese requirements and enable testers to test that the system satisfies these requirements.This document is structured according to the IEEE 830-1998 standard [IEEE-830].
    • Software Requirements Specification for Eloha View Page 32. Overall Description2.1 Product PerspectiveThe EV will provide a nice GUI for the Eloha Card Game, which will be easy and intuitiveto use.2.2 Product Features2.2.1 Supported functions - intuitive control over the game through mouse and hotkeys - support for at least 4 players - changeable Skins of cards and table2.2.2 Unsupported functions - The EV will not implement any functionality of the Eloha Card Game itself. Please consult the ECG SRS regarding these issues.2.3 Operating EnvironmentThe EV will work on any Platform where the SUN Java Runtime Environment is running.
    • Software Requirements Specification for Eloha View Page 43. Specific RequirementsThis Section contains all software requirements, both functional and non-functional.A requirement has the following properties:Requirement ID Uniquely identifies the requirement within all EV documents.Title Gives the requirement a symbolic name, and defines functional property.Description Gives the definition of the requirement.Priority Defines the order in which requirements should be implemented. Priorities are designated (highest to lowest) “1”, “2”, and “3”. Requirements of priority 1 must be implemented in the first productive system release. The requirements of priority 2 and lower are subject of special release-agreement, which is out of scope of this document.References Gives links to related requirements.3.1 FunctionalityThis Section describes the main functional requirements of the EV. The requirements arestructured into an Event Group and a Action Group, where they are grouped into logicalclusters.3.1.1 Events3.1.1.1 HandRequirement ID R1.01.01Title card clicked (card)Description This event shall be triggered when the user activates a card on his hand.Priority 1PrerequisitesRequirement ID R1.01.02Title card switch (card1, card2)Description This event shall be triggered when the user switches two cards per drag and drop.Priority 1Prerequisites3.1.1.2 DeckRequirement ID R1.02.01Title kill clickedDescription This event shall be triggered when the user activates the kill button.Priority 1Prerequisites The kill button is available (R2.03.02).
    • Software Requirements Specification for Eloha View Page 5Requirement ID R1.02.02Title play clickedDescription This event shall be triggered when the user activates the play button.Priority 1Prerequisites The play button is available (R2.03.03).Requirement ID R1.02.03Title pass clickedDescription This event shall be triggered when the user activates the pass button.Priority 1Prerequisites The pass button is available (R2.03.04).Requirement ID R1.02.04Title give clickedDescription This event shall be triggered when the user activates the give button.Priority 1Prerequisites The give button is available (R2.03.05).3.1.1.3 GeneralRequirement ID R1.03.01Title Serve gameDescription This event shall be triggered when the user activates the serve game buttonPriority 1Prerequisites serve game button is available (R2.05.01)Requirement ID R1.03.02Title Connect (Host)Description This event shall be triggered when the user enters a host to connect to and confirms.Priority 1Prerequisites connect button is available (R2.05.02).Requirement ID R1.03.03Title New gameDescription This event shall be triggered when the user activates the new game button.Priority 1Prerequisites new game button is available (R2.05.03).Requirement ID R1.03.04Title Leave gameDescription This event shall be triggered when the user activates the leave game button.Priority 1Prerequisites leave game button is available (R2.05.04).Requirement ID R1.03.05Title Quit game
    • Software Requirements Specification for Eloha View Page 6Description This event shall be triggered when the user activates the quit game button.Priority 1Prerequisites quit game button is available (R2.05.05).Requirement ID R1.03.06Title Change skin (skin)Description This event shall be triggered when the user activates the change skin button.Priority 3Prerequisites change skin button is available (R2.05.06).Requirement ID R1.03.07Title Change name (name)Description This event shall be triggered when the user changes his name.Priority 1Prerequisites change skin button is available (R2.05.06).Requirement ID R1.03.08Title Start gameDescription This event shall be triggered when the user activates the start game button.Priority 1Prerequisites change skin button is available (R2.05.06).3.1.2 Actions3.1.2.1 Other PlayersRequirement ID R2.01.01Title add (player)Description This action shall add a player to the table.Priority 1Prerequisites The maximal number of players is not reached.Requirement ID R2.01.02Title remove (player)Description This action shall remove a player from the table.Priority 1Prerequisites The Player is at the table (R2.01.01).Requirement ID R2.01.03Title set card count (player, card count)Description This action shall set the number of cards a player has on his hand.Priority 1Prerequisites The player is at the table (R2.01.01).Requirement ID R2.01.04
    • Software Requirements Specification for Eloha View Page 7Title set points (player, points)Description This action shall set the points of a player.Priority 1Prerequisites The player is at the table (R2.01.01).Requirement ID R2.01.05Title set turn (player, turn)Description This action shall set whether it is the players turn.Priority 1Prerequisites The player is at the table (R2.01.01).Requirement ID R2.01.06Title set role (player, role)Description This action shall set the role of the player.Priority 1Prerequisites The player is at the table (R2.01.01).3.1.2.2 HandRequirement ID R2.02.01Title set size (size)Description This action shall set number of card slots the user has.Priority 1PrerequisitesRequirement ID R2.02.02Title set card (slot, card)Description This action shall set a given slot to a specific cardPriority 1Prerequisites The slot exists (R2.02.01).Requirement ID R2.02.03Title highlight card (slots)Description This action shall highlight the card at the specific slot.Priority 1Prerequisites The slot exists (R2.02.01), there is a card in the slot (R2.02.02), and the hand needs to be active (R2.02.05)Requirement ID R2.02.04Title un-highlight card (slots)Description This action shall un-highlight the card at the specific slot.Priority 1Prerequisites The slot exists (R2.02.01), there is a card in the slot (R2.02.02), and the hand needs to be active (R2.02.05)Requirement ID R2.02.05Title set activeDescription This action shall set the hand to activePriority 1Prerequisites
    • Software Requirements Specification for Eloha View Page 8Requirement ID R2.02.06Title set inactiveDescription This action shall set the hand to inactivePriority 1Prerequisites The hand was active (R2.02.05).Requirement ID R2.02.07Title play cards (slots)Description This action shall play the cards from the given slots.Priority 1Prerequisites The slots exist (R2.02.01) and there are cards in them (R2.02.02).Requirement ID R2.02.08Title give cards (slots, player)Description This action shall give the cards to another player.Priority 1Prerequisites The slots exist (R2.02.01), there are cards in them (R2.02.02), and the player is at the table (R2.01.01)3.1.2.3 DeckRequirement ID R2.03.01Title set turn (turn)Description This action shall whether the user is on turn.Priority 1PrerequisitesRequirement ID R2.03.02Title set kill available (available)Description This action shall set the availability of the kill button.Priority 1PrerequisitesRequirement ID R2.03.03Title set play available (available)Description This action shall set the availability of the play button.Priority 1PrerequisitesRequirement ID R2.03.04Title set pass available (available)Description This action shall set the availability of the pass button.Priority 1PrerequisitesRequirement ID R2.03.05Title set give available (available)Description This action shall set the availability of the give button.Priority 1Prerequisites
    • Software Requirements Specification for Eloha View Page 9Requirement ID R2.03.06Title set message (message)Description This action shall set a specific message on the message field of the user.Priority 1PrerequisitesRequirement ID R2.03.07Title clear messageDescription This action shall clear the message field of the user.Priority 1PrerequisitesRequirement ID R2.03.08Title set role (role)Description This action shall set the role of the user.Priority 1Prerequisites3.1.2.4 StackRequirement ID R2.04.01Title set size (size)Description This action shall set the number of slots of the stack.Priority 1PrerequisitesRequirement ID R2.04.02Title set card (stack position, card)Description This action shall set a given slot of the stack to a specific card.Priority 1Prerequisites The card and the slot of the stack exist (R2.04.01).Requirement ID R2.04.03Title clear stackDescription This action shall remove all cards and slots from the stack.Priority 1Prerequisites3.1.2.5 GeneralRequirement ID R2.05.01Title set serve game availableDescription This action shall set the availability of the set serve game button.Priority 1PrerequisitesRequirement ID R2.05.02Title set connect availableDescription This action shall set the availability of the set connect button.
    • Software Requirements Specification for Eloha View Page 10Priority 1PrerequisitesRequirement ID R2.05.03Title set new game availableDescription This action shall set the availability of the set new game button.Priority 1PrerequisitesRequirement ID R2.05.04Title set leave availableDescription This action shall set the availability of the set leave button.Priority 1PrerequisitesRequirement ID R2.05.05Title set quit game availableDescription This action shall set the availability of the set quit game button.Priority 1PrerequisitesRequirement ID R2.05.06Title set skins availableDescription This action shall set the availability of the change skin button.Priority 3PrerequisitesRequirement ID R2.05.07Title set start game availableDescription This action shall set the availability of the start game button.Priority 1Prerequisites3.2 Usability3.2.1 DocumentationRequirement ID R_NF1.01.01Group UsabilityDocumentationDescription The system documentation shall be sufficient to start using the EV immediately after the first reading. The documentation shall describe all implemented system functionality.Priority 1References3.2.2 LanguageRequirement ID R_NF1.02.01
    • Software Requirements Specification for Eloha View Page 11Group UsabilityLanguageDescription All system messages, texts and the help documentation must be in English.Priority 1ReferencesRequirement ID R_NF1.02.02Group UsabilityLocalizationDescription The system shall be designed in that way, that the localization (translation of the GUI, all system messages, documentation and help into other languages) can be done within 3 days by 1 persons under condition that all text strings are translated into the goal language.Priority 2References3.3 Reliability3.3.1 Error handlingRequirement ID R_NF1.03.01Group ReliabilityError handlingDescription The system shall provide full information about failures and errors. The information shall include: time of failure, origin (subsystem or component) where a failure occurred and description of error or failure.Priority 3References3.4 Deployment3.4.1 InstallationRequirement ID R_NF1.04.01Group DeploymentInstallationDescription The EV shall run on the SUN JRE and therefore must not need any specific installationPriority 1References
    • Software Requirements Specification for Eloha View Page 123.5 System3.5.1 Supported Operating SystemsRequirement ID R6.01.01Group SystemSupported OSDescription The EV shall run on any OS that supports the SUN JREPriority 1References