Anda di halaman 1dari 11

Software Requirements Specification

for

Or de lAcadie British Side


Version 1.0 approved

Prepared by Travis Russell

Group Five Design

January 31st, 2012

Software Requirements Specification for British Side

Page ii

Table of Contents
1. Introduction................................................................................................................................1
1.1 Purpose ............................................................................................................................................... 1.2 Document Conventions....................................................................................................................... 1.3 Intended Audience and Reading Suggestions..................................................................................... 1.4 Product Scope..................................................................................................................................... 1.5 References........................................................................................................................................... 2.1 Product Perspective............................................................................................................................. 2.2 Product Functions............................................................................................................................... 2.3 User Classes and Characteristics........................................................................................................ 2.4 Operating Environment....................................................................................................................... 2.5 Design and Implementation Constraints............................................................................................. 2.6 User Documentation........................................................................................................................... 2.7 Assumptions and Dependencies......................................................................................................... 1 1 1 2 2 2 2 3 3 4 4 4

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

3. External Interface Requirements............................................................................................. 5


3.1 User Interfaces.................................................................................................................................... 5 3.2 Hardware Interfaces............................................................................................................................ 5 3.3 Software Interfaces............................................................................................................................. 5

4. System Features......................................................................................................................... 5
4.1 Translator (Puzzle Mini Game).......................................................................................................... 5 4.2 NPC Messenger................................................................................................................................... 6

5. Other Nonfunctional Requirements.........................................................................................6


5.1 Performance Requirements................................................................................................................. 5.2 Safety Requirements........................................................................................................................... 5.3 Security Requirements........................................................................................................................ 5.4 Software Quality Attributes................................................................................................................ 5.5 Business Rules.................................................................................................................................... 6 7 7 7 7

6. Other Requirements.................................................................................................................. 7

Revision History
Name Travis Russell Date Reason For Changes Version 1.0 28/01/12 First Edition

Page ii

Software Requirements Specification for the British Side

1.
1.1

Introduction
Purpose

This SRS serves to provide documentation of Or de lAcadie British Side 1.0 including goals, definitions, and capabilities, as well as to formally specify all the requirements necessary for the product.

1.2

Document Conventions

Italics are used throughout this document to indicate the title of either a separate document or a section of the SRS. Double Quotes are used to indicate that the word appears in the glossary, which is found under Appendix A.

1.3

Intended Audience and Reading Suggestions

The intended audiences of this SRS include: Group Five Design Staff Project Managers Software Engineers Testers Documentation Writers Help Staff Developers Independent Game Studios Users Individuals who play Or de lAcadie The rest of this document is organized as follows, and is meant to be read in sequential order: Introduction, which introduces the specifications of the product and document. Overall Description, which goes into further details of the product, including constraints and assumptions. External Interface Requirements, which specifies the necessary requirements for the products interfaces. System Features, which describes in detail the features which are to be implemented into the product. Other Nonfunctional Requirements, which specifies other requirements of the product, i.e. security requirements, safety requirements, etc. Other Requirements, which specifies any other requirements of the product. Appendices A-B, which contain addition information about the project.

Page 1

Software Requirements Specification for the British Side

1.4

Product Scope

Or de lAcadie is an interactive computer game which pits the French against the British who are in pursuit of gold and treasure. This document is specifically focused on the improvement of the user experience for users playing as the British side. Group 5 Design aims to do this by inserting two new features: a puzzle mini game mimicking the act of translating a document, as well as inserting a NPC which aids in the communication between users. Inserting these features would create a more far more interesting user experience, aiding in the popularity of the game. For more on the product scope, including what falls out of the product scope, reference this products Project Charter and Project Plan.

1.5

References

This document references the following document(s): Or de lAcadie British Side Project Charter (v. 1.0): o A document which outlines the milestones and overview of the product. Or de lAcadie British Side Project Plan (v 1.0): o A document which outlines the planned evolution of the product.

It also makes many references to Open Wonderland, which can be found at http://openwonderland.org/

2.
2.1

Overall Description
Product Perspective

Or de lAcadie was initially developed as a computer game using Open Wonderland framework. The game combined innovative methods of user controls with traditional mouse and keyboard controls to pit the French against British soldiers in pursuit of treasure. The game was never completed, however the aim of this product is to use the pre-existing Or de lAcadie framework to develop an improved user experience for the users controlling the British soldiers. There are 14 additional development teams which have also begun similar work, each focusing on improving a different aspect of the game.

2.2

Product Functions

This product aims to insert two major functions to the pre-existing framework: A puzzle mini game to be solved by the user o Emulates the translating of a French document to English o Will take the form of a sliding puzzle o Number of pieces determined by difficulty level An NPC which helps with communication between users o Will carry written messages between users o Will take the form of a British Soldier

Page 2

Software Requirements Specification for the British Side

2.3

User Classes and Characteristics

List of expected users: Gaming Use o Recreational Users Users who use the product as a form of recreation or fun. Amount of product use can range from one to fifty hours a week. o Competitive Users Users who use the product as a form of competition, sometimes with prizes offered. Amount of product use can range from one to one hundred hours a week. o Critics Users who will use some system to rate the product. Amount of product use can range from one to twenty hours (one time user). o Educational Users Users who use the product as an educational tool. These can involve teachers, students, librarians, etc. Amount of product use can range from one to five hours a week. Development/Employee Use o Game Developers Users who will further develop and evolve the game. Most time is spent on coding rather than on product use. o Help Staff Users who use their knowledge of the product to aid others having difficulty with the product. Not much time is spent using the product itself.

While Group 5 Design recognizes it is most important to satisfy the gaming users, it is also important to maintain an organized documentation system so to satisfy developmental/employee users as well.

2.4

Operating Environment

The software will operate in the following environment: Hardware o Any modern PC or Mac o 1.5 Ghz (+) Processor o 1 GB Ram o 128 MB(+) Graphics Card Operating System o Windows o Mac OS X o Linux o Solaris Software Necessities o Open Wonderland

Page 3

Software Requirements Specification for the British Side

2.5

Design and Implementation Constraints

Major constraints on design and implementation include: Time o With a projected finish date of March 29th, 2012, this leaves little time for project development. It is essential that Group 5 Design stays within scope and works quickly and efficiently in order to meet this deadline. Programming o With all members of the team being unfamiliar with Open Wonderland, the task of creating a product using its framework is daunting. The members are unsure about the capabilities of the framework, meaning the scope may be compromised. This will be overcome with education about the framework and adaptability by team members. o Coding on top of previous code may cause problems and setback the project. o The program is to be written using Java, which is no setback because of the teams familiarity with the language. o Documentation is essential and must be organized and follow a specific standard.

2.6

User Documentation

The following list of items will be used to document the product:


Milestone/Deliverable Planned Completion Date

Project charter Project plan, requirements document Prototype 1: throwaway Design documents Prototype 2: implementation steel thread Updated documents User manual Deployment guide Demo

January 20, 2012 January 31, 2012 February 14, 2012 February 28, 2012 March 13, 2012 March 27, 2012 March 27, 2012 March 27, 2012 March 29, 2012

2.7

Assumptions and Dependencies

Most assumptions are based on what Group 5 Design has seen of Open Wonderland. One assumption is that the British Soldiers will all have basic controls such as movement and the ability to communicate with other users. Another assumption is that the framework is written in Java, well documented and easily modifiable. This product will depend largely on the capabilities and modifiability of Open Wonderland as well as the previously made Or de lAcadie game. If these assumptions are not correct, it could severely limit the scope of the product or vastly increase development time. See the Product Plan for more on assumptions and dependencies.

Page 4

Software Requirements Specification for the British Side

3.
3.1

External Interface Requirements


User Interfaces

The user interfaces will be solely based off of the Open Wonderland framework. And to be more specific to the interfaces that has already been created in the Or de lAcadie game.

3.2

Hardware Interfaces

The hardware that is required must be able to support the Open Wonderland framework. This includes a modern PC (1.5 Ghz+, 1GB RAM) with hardware accelerated OpenGL drivers installed. Also, a graphics card that supports 3-D gaming, the recommended graphics card should have 256MB of video memory for an optimal experience.

3.3

Software Interfaces

In order for users to be able to run either the translator or NPC messenger modules, they will need to have Open Wonderland framework and Java 6 JRE installed. In the case of developers who wish to create additional characters or make changes to characters they will need some software to create or modify 3-D models and Java 6 JDK.

4.
4.1

System Features
Translator (Puzzle Mini Game)
4.1.1 Description and Priority
The translator will act as a way to make the game more entertaining and stimulating for the user. Notes and signs written in French will be found throughout the game by the British side users. These notes and signs can then be deciphered and translated to English by completing a traditional slide puzzle in a specified time limit. The translated message will provide valuable information to the British side in their pursuit for treasure. The number of pieces in the puzzle and time allotted to the user will depend on the importance of the translated information. Priority: High

4.1.2

Stimulus/Response Sequences (See Appendix B for Use Case Diagram)


1. The user finds either a note or sign which is in French. 2. The user initiates the translator. 3. The user then attempts to solve the puzzle within the allotted time limit. 4. (i) If time runs out before the puzzle is solved, the sign will not be able to be translated for the rest of the game.

Page 5

Software Requirements Specification for the British Side

4 (ii) If the puzzle is solved before time is up, a translated message appears on screen.

4.1.3

Functional Requirements
REQ-1: A way to implement the puzzle REQ-2: A built in timer REQ-3: TBD

4.2

NPC Messenger
4.2.1 Description and Priority

To retain some historical accuracy and reality in the product, British soldiers will not be able to communicate when they are out of realistic ear range. An NPC will be implemented to allow the users who control the British soldiers to communicate with each other through written messages. There will be a set length to these messages (140 characters).

4.1.2

Stimulus/Response Sequences (See Appendix B for Use Case Diagram)


1. The user is out of earshot of the other user controlling the British side and wishes to send a message. 2. The user initiates the message though the menu or by clicking on the NPC. 3. The user then writes the message using a standard keyboard. 4. The NPC then delivers the message to the other user at a realistic speed. 5. The other user receives the message by clicking on the NPC. 6. The other user then reads the message, and acts accordingly.

4.1.3

Functional Requirements
REQ-1: A forum to write the message on REQ-2: A method to allow the NPC to find the other user REQ-3: TBD

5.
5.1

Other Nonfunctional Requirements


Performance Requirements

See 2.4 Operating Environment for a list of hardware requirements to run the software.

Page 6

Software Requirements Specification for the British Side

5.2

Safety Requirements

Just like anything, this product is best used in moderation. Overplaying of any computer game can result in serious conditions such as, but not limited to: vision problems, depression, carpel tunnel syndrome, etc. If the user has a history of epileptic seizures, precaution must be taken.

5.3

Security Requirements

This project is open source; therefore code confidentiality is not an issue. While this is true, precautions will be taken so that no sabotaging of code will occur by password protecting all code in progress. The product itself has no implications regarding security.

5.4

Software Quality Attributes


Correctness The product must retain some historical accuracy and be error free. Flexibility The product must be able to bend itself for different developers. Maintainability The code must be maintained well and efficiently. Portability The product must be able to work across a variety of operating systems. Reliability The product must be bug free and be without crashes. Usability The product must provide a user friendly and entertaining experience.

5.5

Business Rules

Project Manager Project the leader of the project and thus delegates tasks. He must oversee the product and make sure it stays within the guidelines set out in documentation. Software Engineers Software engineers must code and document efficiently. They too are responsible to make sure the project stays within the guidelines.

6.
N/A

Other Requirements

Appendix A: Glossary
Slide Puzzle: A puzzle which requires a player to slide flat pieces along certain routes in order to reach an end configuration. NPC: Non-Player Character. A character which is not controlled by a user, but rather by preprogrammed code.

Appendix B: Analysis Models


Functional Requirements (Translator Use Case Diagram)

Page 7

Software Requirements Specification for the British Side

Translator (Puzzle M ini Game )

Read French Sign

British Gam e P layer Initiate Translator

Solve P uzzle

Page 8

Software Requirements Specification for the British Side

Functional Requirements (NPC Messenger Use Case Diagram)


NP Me s ng r C se e

CreateMessage

British GamePlayer

Read Message

Deliver Message

British NPC

Page 9