The Three W`s - University of Mount Union

AVI Nutrition Application
Software Requirements
Specification
3W_SRS.doc
Draft 1
April 17, 2013
The Three W’s
[ Paste Your Organization’s Logo Here ]
The Three W’s
[ Project ] - Software Requirements Specification
Revisions
Version
Primary
Author(s)
Description of Version
Draft 1.0
Gus Delawder,
Matt Amabeli
The first draft of the SRS document. This document contains an introduction to the anticipated
product.
02/05/13
Final
Version
Ross Allison,
The completed version of the SRS document. This
document has the complete details of the project as
of 2/11/13. May require additional maintenance as
the project progresses.
2/11/13
3W_SRS.doc
Kevin Placek
Date
Completed
Page i
The Three W’s
[ Project ] - Software Requirements Specification
Contents
1 INTRODUCTION ...........................................................................................................1 1.1 PURPOSE ...................................................................................................................1 1.2 SCOPE .......................................................................................................................1 1.3 DEFINITIONS, ACRONYMS, AND ABBREVIATIONS......................................................1 1.4 REFERENCES .............................................................................................................1 1.5 OVERVIEW ................................................................................................................1 2 OVERALL DESCRIPTION .............................................................................................2 2.1 PRODUCT PERSPECTIVE .............................................................................................2 2.1.1 System Interfaces ........................................................................................................ 2 2.1.2 User Interfaces ........................................................................................................... 2 2.1.3 Hardware Interfaces ................................................................................................... 2 2.1.4 Software Interfaces ..................................................................................................... 2 2.1.5 Communications Interfaces ........................................................................................ 2 2.1.6 Memory Constraints ................................................................................................... 2 2.1.7 Operations .................................................................................................................. 3 2.1.8 Site Adaptation Requirements .................................................................................... 3 2.2 PRODUCT FUNCTIONS ...............................................................................................3 2.3 USER CHARACTERISTICS ...........................................................................................3 2.4 CONSTRAINTS ...........................................................................................................3 2.5 ASSUMPTIONS AND DEPENDENCIES ..........................................................................3 2.6 APPORTIONING OF REQUIREMENTS ...........................................................................3 3 SPECIFIC REQUIREMENTS ..........................................................................................4 3.1 EXTERNAL INTERFACE REQUIREMENTS ....................................................................4 3.1.1 User Interfaces ........................................................................................................... 4 3.1.2 Hardware Interfaces ................................................................................................... 4 3.1.3 Software Interfaces ..................................................................................................... 4 3.1.4 Communications Interfaces ........................................ Error! Bookmark not defined. 3.2 SOFTWARE PRODUCT FEATURES ...............................................................................4 3.2.1 Feature 1 .................................................................... Error! Bookmark not defined. Purpose ........................................................................................................................................4 Stimulus/Response Sequence .................................................... Error! Bookmark not defined. Associated Functional Requirements ........................................ Error! Bookmark not defined. 3.3 PERFORMANCE REQUIREMENTS ........................ERROR! BOOKMARK NOT DEFINED. 3.4 DESIGN CONSTRAINTS ..............................................................................................5 3.5 SOFTWARE SYSTEM ATTRIBUTES ..............................................................................5 3.5.1 Reliability ................................................................................................................... 5 3.5.2 Availability ................................................................................................................. 5 3.5.3 Security ....................................................................................................................... 5 3W_SRS.doc
Page ii
The Three W’s
[ Project ] - Software Requirements Specification
3.5.4 Maintainability ........................................................................................................... 5 3.6 LOGICAL DATABASE REQUIREMENTS .......................................................................6 3.7 OTHER REQUIREMENTS .....................................ERROR! BOOKMARK NOT DEFINED. 4 SOFTWARE LIFE CYCLE MODEL ...............................................................................7 4.1 CHOICE OF SOFTWARE LIFE CYCLE MODEL ..............................................................7 4.2 JUSTIFICATION FOR CHOICE OF MODEL .....................................................................7 3W_SRS.doc
Page iii
The Three W’s
[ Project ] - Software Requirements Specification
1 Introduction
1.1 Purpose
This Software Requirements Specification document for the AVI Nutrition Application details the functionality to be included in the finished iOS and web applications. The intended
audience of this specification includes employees of AVI, the 3W’s team, interested Mount
Union students, and CSIS faculty.
1.2 Scope
The software product to be produced is an AVI Nutrition Website and companion iOS app.
Our product may be used by the general public to document a person’s daily caloric intake
and help promote a healthy lifestyle. Users will log into an account where they can track their
caloric intake over a period of time, based on the menu rotation at the University of Mount
Union’s Dining Commons.
1.3 Definitions, Acronyms, and Abbreviations
LAN – Local Area Network
1.4 References
"AVI Foodsystems." AVI Foodsystems Inc. AVI Foodsystems Inc, n.d. Web. 11 Feb. 2013.
1.5 Overview
The Software Requirements Specification document for the implementation of the AVI Nutrition website and companion iOS application contains details about the overall workings of
the website and application. The document contents include both general details and specific
functionality provided to the user. The following section gives a basic overview of the features found in the web and mobile applications and the use of those features. The third section
goes into more precise detail about the interface. The final section describes our chosen software life cycle model.
FinalSRS.doc
Page 1
The Three W’s
[ Project ] - Software Requirements Specification
2 Overall Description
2.1 Product Perspective
This website and mobile application will be similar to the myFitnessPal site and application
created by Silesco, but with a focus on the University of Mount Union community and the
dining options presented by AVI.
2.1.1 System Interfaces
HTML files and Objective-C files will be used by the application and website.
2.1.2 User Interfaces
Web - This portion includes tabs offering these choices: About, AVI's Food, Recommended
Exercise, and the Mobile Application. Additionally, a Login screen will be displayed for each
user to sign in and make full use of the services provided.
Mobile - This portion includes tabs for the following choices: About, AVI's Food, Recommended Exercise and Login.
2.1.3 Hardware Interfaces
The web portion of this product will be supported by any computer, and the mobile application will be supported by products capable of running Apple's iOS.
2.1.4 Software Interfaces
The mobile application will function only on Apple’s iOS. The web portion of this product
will be compatible with all web browsers and computers.
2.1.5 Communications Interfaces
The user needs access to the Internet for the web application as well as access to a wireless
router or carrier provided data to sync data from the mobile application to the web application.
2.1.6 Memory Constraints
The application will take some space on the user's mobile device. The amount of space is yet
to be determined, but we will strive to keep this amount as small as possible.
FinalSRS.doc
Page 2
The Three W’s
[ Project ] - Software Requirements Specification
2.1.7 Operations
The user will select the foods consumed from an available menu to add to his/her daily calories consumed. To make an account, the user chooses a username and password, and enters a
valid email address. To get the user’s generalized daily caloric recommendation, the user
must input his/her gender, height, weight, and age – this information will be stored in the
database under the user’s account.
2.1.8 Site Adaptation Requirements
The team must modify the data to be entered into AVI's database using SQL. Additionally,
the team is creating the website with a grid style to accommodate the wide variety of monitor
sizes.
2.2 Product Functions
The finished product will keep track of the user’s daily caloric intake and daily calorie target.
Some exercises will be recommended to the user to aid in weight loss.
2.3 User Characteristics
The intended audience of this product is Mount Union students and faculty who are interested
in pursuing a healthy lifestyle.
2.4 Constraints
The team needs to provide a secure method of entering usernames and passwords, as well as
protecting user accounts. The mobile application must be designed and developed on a current Macintosh system.
2.5 Assumptions and Dependencies
The team is assuming that all desired features are possible within our time constraints. Placeholders must also be created for future features to be implemented
2.6 Apportioning of Requirements
Features that will most likely come in a future version include a community group in which
users can search for support from other users, a barcode scanner, expansion to include other
institutions that use AVI food services, a more specific workout regimen for users, and more
individualized caloric intake suggestions.
FinalSRS.doc
Page 3
The Three W’s
[ Project ] - Software Requirements Specification
3 Specific Requirements
3.1 External Interface Requirements
3.1.1 User Interfaces
User interfaces will include a variety of tabs related to the foods they are eating, their nutritional value and their caloric intake.
3.1.2 Hardware Interfaces
Users will need a mobile device capable of running iOS software.
3.1.3 Software Interfaces
Mobile application users will need to be running iOS software. Web site users will need a
modern web browser.
3.2 Software Product Features
3.2.1 Food Database
Purpose
Nutritional information will be stored in this database for the application to access in order to
customize the calorie counter and exercise suggestions.
3.2.2 Administration Page
Purpose
The administration page feature was requested by the client so that when the team is no longer a part of the project, the food database may be updated and maintained by the client’s personnel.
3.2.3 User accounts
Purpose
User accounts are necessary to the application so that data may be synced to the web application, and a more personalized plan can be developed.
FinalSRS.doc
Page 4
The Three W’s
[ Project ] - Software Requirements Specification
3.2.4 Thumbs up button
Purpose
If a student or faculty member really enjoys a food being offered that day, he or she can give
the food a thumbs up in the application, letting other students and faculty know that it is a
good choice for their meal. This is also helpful to AVI in that they can get a sense of what
foods go over well, and what is not well liked.
3.2.5 Location select
Purpose
This feature is proposed as a way to integrate the application with all institutions for which
AVI food systems provides their services. The user selects his/her location and the menus
adjust accordingly.
3.3 Acceptance Criteria
In order for the project to be considered successful, the finished product will allow users to
input their food choices, maintain records of their caloric intake, get suggested exercise routines, and vote “thumbs up” for food that they enjoyed. This data will be synced with a web
application keeping backup records of all of the information.
3.3 Design Constraints
User accounts must be protected and kept secure.
3.4 Software System Attributes
3.4.1 Reliability
The application must always pull the right nutritional information from the food database,
and keep an accurate count of calories consumed.
3.4.2 Availability
The application must always be accessible.
3.4.3 Security
Measures will be taken to protect user information, such as cryptography and linking with a
valid email address.
3.4.4 Maintainability
The administration page feature exists so that members of the AVI team can edit the nutritional database, which will be hosted on their servers at the end of project development.
FinalSRS.doc
Page 5
The Three W’s
[ Project ] - Software Requirements Specification
3.5 Logical Database Requirements
User information, as well as all nutritional information about the foods served by AVI will be
entered into the database.
FinalSRS.doc
Page 6
The Three W’s
[ Project ] - Software Requirements Specification
4 Software Life Cycle Model
4.1 Choice of Software Life Cycle Model
The Software Life Cycle model to be used for this project is Design to Schedule.
4.2 Justification for Choice of Model
Design to Schedule was chosen for this project because the team has a very specific hard
deadline which is the 25th of April 2013.
FinalSRS.doc
Page 7