Difference: SoftwareRequirementsSpecificationMarcus (3 vs. 4)

Revision 42012-05-16 - MarcusHartzler

Line: 1 to 1
 
META TOPICPARENT name="HartzlerMarcusCAP"
1. Introduction
  • 1.1 Product Overview
Changed:
<
<
This project is to create a web-based system for inputting data for a sports league over a wide range of sports. Not only should this system be able to store different leagues (per sport), teams in the leagues, and players on the teams, but it should also store scheduling information (per sport), like weeks, days in a week, games in a day, teams playing in the games, game time, game location, etc. Even more detailed, the system should allow for individual stats to be kept track of and scores to be submitted for games and all of that to be kept track of in the database. The web-based system should also present the information in an aesthetically pleasing way for anyone to view. To do this, the system will most likely use but is not limited to using HTML, Javascript, jQuery, PHP, and XML.
>
>
    • This project is to create a web-based system for inputting data for a sports league over a wide range of sports. Not only should this system be able to store different leagues (per sport), teams in the leagues, and players on the teams, but it should also store scheduling information (per sport), like weeks, days in a week, games in a day, teams playing in the games, game time, game location, etc. Even more detailed, the system should allow for individual stats to be kept track of and scores to be submitted for games and all of that to be kept track of in the database. The web-based system should also present the information in an aesthetically pleasing way for anyone to view. To do this, the system will most likely use but is not limited to using HTML, Javascript, jQuery, PHP, and XML.
 
Changed:
<
<
  • 1.2 Human Resources
The people that are going to (and currently) use this website are the students and faculty of MVNU. They will all use the viewing capabilities of the website, so they’ll be able to see when games are, who’s playing who, what the standings of the different leagues are, etc. As far as using the website to actually input data, just the MVNU intramural staff will be using that interface.

  • 1.3 Business Context Not applicable.
>
>
  • 1.2 Human Resources
    • The people that are going to (and currently) use this website are the students and faculty of MVNU. They will all use the viewing capabilities of the website, so they’ll be able to see when games are, who’s playing who, what the standings of the different leagues are, etc. As far as using the website to actually input data, just the MVNU intramural staff will be using that interface.
 
Added:
>
>
  • 1.3 Business Context Not applicable.
 2. User Requirements
Changed:
<
<
  • 2.1 User Objectives Users would like to be able to use this site to change the data in the database without needing to have any experience with programming or working with code at all, so the interface should be user friendly and should be completely web-based.
>
>
  • 2.1 User Objectives Users would like to be able to use this site to change the data in the database without needing to have any experience with programming or working with code at all, so the interface should be user friendly and should be completely web-based.
    • The system shall provide an interface for editing sports leagues and schedules. This includes adding, editing, and deleting capabilities for weeks, days, games, leagues, teams, and players.
    • The system shall have a database to store all league and schedule information, including team and individual stats.
    • The system shall have interfaces for viewing schedules, leagues, and individual stats.
    • The system shall have interfaces for viewing upcoming events, intramural staff information, and the intramural calendar.
    • The system shall have a database to store upcoming events and the intramural staff information.
 
  • 2.2 Similar System Information
Changed:
<
<
This product is a stand-alone product.
>
>
    • This product is a stand-alone product.
 
  • 2.3 User Characteristics
Changed:
<
<
The user community will only be able to use basic web site navigation and input straight forward forms in web sites.
>
>
    • The user community will only be able to use basic web site navigation and input straight forward forms in web sites.
 
  • 2.4 User Problem Statement
Changed:
<
<
The user’s problem is that currently there isn’t really a good way for information regarding intramurals to be made available for everyone to see in a consistent way. There were attempts made to create an area on the MVNU SGA website to show the intramural schedules, standings, and stats, but the amount of work needed to keep up the information was very taxing because the HTML had to be changed and then updated and the stats had to be calculated by hand and stored in files that weren’t used by the site itself.

3. Functional Requirements

>
>
    • The user’s problem is that currently there isn’t really a good way for information regarding intramurals to be made available for everyone to see in a consistent way. There were attempts made to create an area on the MVNU SGA website to show the intramural schedules, standings, and stats, but the amount of work needed to keep up the information was very taxing because the HTML had to be changed and then updated and the stats had to be calculated by hand and stored in files that weren’t used by the site itself.
3. Functional Requirements
  I. Data Input
  • Description - The system should allow users to input data and store that data in a database.
Line: 59 to 56
 
  • Criticality - Very important, this is the whole point of the system. If no one could see the data, there would be no point in having it in the first place.
  • Risks - A bad user interface would make it hard to require people to rely on the website to find out information regarding intramurals.
  • Dependencies with other requirements - This is dependent on the database because it needs to show the most current data stored in the database.
Changed:
<
<
4. Interface Requirements
>
>
4. Interface Requirements
 
  • 4.1 User Interfaces - The user interface is just a webpage.
Changed:
<
<
4.1.1 GUI

4.1.2 CLI - Not applicable.

4.1.3 API - Not applicable.

4.1.4 Diagnostics - Not applicable.

>
>
    • 4.1.1 GUI
    • 4.1.2 CLI - Not applicable.
    • 4.1.3 API - Not applicable.
    • 4.1.4 Diagnostics - Not applicable.
 
  • 4.2 Hardware Interfaces
Changed:
<
<
◦ A personal computer, mouse and keyboard.
>
>
    • A personal computer
    • A mouse
    • A keyboard.
 
  • 4.3 Communications Interfaces
Changed:
<
<
◦ The computer has to be connected to the internet.
>
>
    • The computer has to be connected to the internet.
 
  • 4.4 Software Interfaces
Changed:
<
<
◦ The computer needs to have a current version of one of the following web browsers:

Safari

Firefox

Google Chrome

Internet Explorer

5. Non-Functional Requirements

>
>
    • The computer needs to have a current version of one of the following web browsers.
      • Safari
      • Firefox
      • Google Chrome
      • Internet Explorer
5. Non-Functional Requirements
 
  • 5.1 Hardware Constraints
Changed:
<
<
◦ Personal computers.
>
>
    • Personal computers.
 
  • 5.2 Performance Requirements
Changed:
<
<
◦ 1 GB of memory and an average bandwidth.
>
>
    • 1 GB of memory and an average bandwidth.
 
  • 5.3 System Environment Constraints
Changed:
<
<
◦ Not applicable.
>
>
    • Not applicable.
 
  • 5.4 Security Requirements
Changed:
<
<
◦ The database should not only be available to intramural staff.

◦ The editing area of the website should only be accessible by intramural staff members.

◦ The usernames and passwords should only be accessible by intramural staff members.

>
>
    • The database should not only be available to intramural staff.
    • The editing area of the website should only be accessible by intramural staff members.
    • The usernames and passwords should only be accessible by intramural staff members.
 
  • 5.5 Reliability
Changed:
<
<
◦ The website shouldn’t crash.
>
>
    • The website shouldn’t crash.
 
  • 5.6 Maintainability
Changed:
<
<
◦ The editing area should be able to be used by anyone who is familiar with entering data.
>
>
    • The editing area should be able to be used by anyone who is familiar with entering data.
 
  • 5.7 Portability
Changed:
<
<
◦ Any device that has web browsing capabilities.
>
>
    • The website and database are both located in the same directory, so to move the site to another server, all you would have to do is zip the directory everything is in and move it all to the new server.
 
  • 5.8 Extensibility
Changed:
<
<
◦ Cannot be used with web browsers that aren’t specified in 4.4.
>
>
    • Cannot be used with web browsers that aren’t specified in 4.4.
 
  • 5.9 Development Process Constraints
Changed:
<
<
◦ Apache server to host the website: allows HTML embedded PHP and SQL databases

◦ PHP: easy-to-use server-side language

◦ HTML: current standard in webpage-formatting

◦ CSS: current standard in HTML styling

◦ JS: easy-to-use client-side language.

>
>
    • Apache server to host the website: allows HTML embedded PHP and SQL databases
    • PHP: easy-to-use server-side language
    • HTML: current standard in webpage-formatting
    • CSS: current standard in HTML styling
    • JS: easy-to-use client-side language.
    • JQUERY: easy-to-use JS library that makes the XHTML structure easy to manipulate
    • AJAX: easy way to call PHP files and an easy way to request XML documents
    • XML: easy way to store data
6. System Models:

  • Intramural Database (XML)
    • year: PK id, title
    • weekday (child of year entity): PK title
    • month (child of year entity): PK title
    • season (child of year): PK id, title
    • sport (child of season): PK id, title, scoring_unit
    • stat (child of sport): PK id, title, calculation
    • court (child of sport): PK title
    • league (child of sport): PK id, title
    • week (child of sport): PK id, title
    • team (child of league): PK id, title, wins, losses, points_for, points_against
    • player (child of team): PK id, first_name, last_name, athlete, gender, paid
    • day (child of week): PK id, FK title, FK month, day
    • game (child of day): PK id, FK team1_id, FK team2_id, team1_score, team2_score, FK court, time, ref
 
Changed:
<
<
◦ JQUERY: easy-to-use JS library that makes the XHTML structure easy to manipulate

◦ AJAX: easy way to call PHP files and an easy way to request XML documents

◦ XML: easy way to store data

SQL: simple database

6. System Models
This section includes diagrams showing relationships between major software components and the system environment. It may include one or more of the following:

Intramural Database (XML)

year: PK id, title

weekday (child of year entity): PK title

month (child of year entity): PK title

season (child of year): PK id, title

sport (child of season): PK id, title, scoring_unit

stat (child of sport): PK id, title, calculation

court (child of sport): PK title

league (child of sport): PK id, title

week (child of sport): PK id, title

team (child of league): PK id, title, wins, losses, points_for, points_against

player (child of team): PK id, first_name, last_name, athlete, gender, paid

day (child of week): PK id, FK title, FK month, day

game (child of day): PK id, FK team1_id, FK team2_id, team1_score, team2_score, FK court, time, ref

7. Operational Scenarios

>
>
7. Operational Scenarios
  Someone views the intramural site:
  1. The client requests the webpage.
Line: 184 to 147
 
  1. The client makes and AJAX call to receive the XML database and reparses it so that the database on the client is up to date.
  2. The information in the HTML is refreshed to reflect the change in the database.
Deleted:
<
<
8. Appendices

  • 10.1 Definitions, Acronyms, Abbreviations – Not applicable.
  • 10.2 References - Not applicable.
 
META FILEATTACHMENT attachment="Software_Requirements_Specification.docx" attr="" comment="Software Requirements Specification" date="1323447972" name="Software_Requirements_Specification.docx" path="Software_Requirements_Specification.docx" size="128761" user="MarcusHartzler" version="1"
 
This site is powered by the TWiki collaboration platformCopyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback