SmartCal - A Learning Planner

SmartCal

Software Requirements Specification

COP4331, Fall, 2014

Modification history:

Version	Date	Who	Comment
v0.0	09/08/14	Joseph Burfield	Template
v0.1	09/09/14	Joseph Burfield	Added team contact info Added sections: software to be produced; applicable standards; Definitions, Acronyms, and Abbreviations; Interface Requirements, Physical Requirements, Users and Human Factors Requirements, Documentation Requirements, Data Requirements, Resource Requirements and Security Requirements
v0.2	09/11/14	Joseph Burfield	Updated sections: Product Overview; Stakeholders; Added sections: Event Tables
v0.3	09/12/14	Joseph Burfield	Updated sections: Definitions, Acronyms, and Abbreviations; Added sections: Functional Requirements; Interface Requirements; Physical Environment Requirements; Users and Human Factors Requirements; Documentation Requirements; Data Requirements; Resource Requirements; Security Requirements; Quality Assurance Requirements;
v0.4	09/13/14	Joseph Burfield	Added sections: Use case diagram; Use case descriptions;
v1.0	09/17/14	Joseph Burfield	Updated sections: Use case diagram; Use case descriptions; Finished first draft

Team Name: Group 9

Team Members:

Salim Andraos andraos@knights.ucf.edu
Joseph Burfield jburfield@knights.ucf.edu
Sachin Nayee Sach@knights.ucf.edu
Paul Perdue perdue1@knights.ucf.edu
Carlos Pereda carloshpereda@knights.ucf.edu
James Choi jameschoi@knights.ucf.edu

Contents of this Document

Introduction

Definition, Acronyms, and Abbreviations

Product Overview

Specific Requirements

Supporting Material

SECTION 1: Introduction

Software to be Produced:

SmartCal is a learning planner that allows the user to upload their schedule, and then the application can give suggestions for unused timeslots. The suggestions are based on the previous user planned activities, the user's profile, likes and dislikes and their rating of past suggestions. SmartCal is a Windows Application that will implement a MySQL database to store the required data. The application will also feature a notification system that can remind the user of their upcoming events and activities.

Reference Documents:

Applicable Standards:

Coding Standard: from aviva solutions we adapt the popular guidelines on the C# programming language. Click link to view pdf. Aviva Solutions Coding Guidelines.
Document Standard: All documentation standards shall follow the templates from the following source http://www.cs.ucf.edu/courses/eel5881/ProjectTemplates.html
Artifact Size Metric Standard: As per the industry standard, our code will be measured in bytes rather than in lines of the source code.

Definitions, Acronyms, and Abbreviations:

C# - An Object Oriented Programming Language developed by Microsoft using the .NET framework.
MySQL - An open source database management language. Stands for My Standard Query Language.

SECTION 2: Product Overview

Assumptions:

The developers assume the users will be using a modern operating system such as Windows 7 or 8, or Mac OS. The developers also assume the user is attempting to run the application on a modern PC that can at least run basic applications like a word processor or browsers.

Stakeholders:

The TA, Rajiv Marothu

Event Table:

Event Name	External Stimuli	External Responses	Internal data and state
Create Profile	Opening application for the first time	Application will be on a "Create Profile" page	Gets profile of user for the application to base suggestions off of and to personalize notifications of upcoming events. Certain values are entered into database. After initial profile is created, the main screen is the starting screen.
View Profile	Clicking on "View Profile" button on interface	Directs to "Profile" form	Allows user to view what they entered for their profile
Edit Profile	Clicking on "Edit Profile" button on the "Profile" page	Directs to "Edit Profile" form	Allows user to modify the values they entered for their profile. Updates certain fields in database
View Calendar	Clicking "View Calendar" button on interface	Directs to "Calendar" page	Allows user to view their calendar
Add Event	Clicking on "Add Event" button on "Calendar" page	Directs to "Add Event" window	Allows user to add an event to their calendar, updates database and suggestions AI
Edit Event	Clicking on an existing event on the user's calendar	Directs to "Edit Event" window	Allows user to edit an event on their calendar, updates database and suggestions AI
Delete Event	Clicking on "Delete Event" after clicking on event to delete on calendar	Deletes event	Allows user to delete an event on their calendar, updates database and suggestions AI
View Suggestions	Clicking on "View Suggestions" button on interface	Directs to "Suggestions" page	Allows user to view current suggestions and rate the current suggestions, and new ones can be added (by program) based off those ratings.

Use Case Diagram:

Use Case Descriptions:

Authenticate User: Once the application runs, it will authenticate the user using Windows Authentication. This will serve as the "loging in" portion of the program.

Create Profile: The application will check if this instance of the program running is the first time the user is running the program. If so, then the user will be prompted to create their profile. After this first time set up, the user will not see the create profile screen again.

View Profile - Allows the user to view the profile they created, this also allows the user also the option to edit or reset their profile.

Edit Profile - Allows the user to edit the profile they created.

Reset Profile - Allows the user to reset their profile and the suggestions generated by the program will also be reset.

View Calendar - Allows the user to view the calender.

Add Event - Allows the user to add an event to the calendar, also allows the user the option to edit an event, delete an event, close an event and to set a reminder.

Edit Event - Allows the user to edit an event they added to the calender.

Delete Event - Allows the user to delete an event they added to the calendar.

Close Event - Allows the user to close the event, which means the event is complete.

Set Reminder - Allows the user to set a reminder of the event they created already.

View Suggestions - Allows the user to view the suggestions the application currently has generated for the user, this also allows the user to now rate the suggestions and use the suggestions in their calendar.

Rate Suggestions - Allows the user to rate the suggestions generated by the application on a 1 to 5 scale, 1 being the lowest and 5 being the highest.

Use Suggestion to Create Event - Allows the user to use the suggestion to add an event to their calendar.

View Statistics - Allows the user to view the statistics generated by the events the user completed or information they entered. The user now has the ability to generate a report.

Generate Report - Allows the user to generate a report of the statistics generated by the applications for the user. This report can be exported into multiple formats.

SECTION 3: Specific Requirements

3.1 Functional Requirements:

No: 1

Statement: The user shall be able to create their profile

Source: Create profile

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: The user will now have access to the rest of the software (the calendar, suggestions, etc.)

Revision History: Joseph Burfield, 09/12/2014

No: 2

Statement: The user shall be able to edit their profile

Source: Edit Profile

Dependency: Create Profile

Conflicts: None

Supporting Materials: UML

Evaluation Method: Any updated information can be seen on View Profile page

Revision History: Joseph Burfield, 09/12/2014

No: 3

Statement: The user shall be able to view and modify their calendar. Including the ability to add events, edit events, delete events, and insert any suggestions.

Source: Calendar page

Dependency: Create Profile

Conflicts: None

Supporting Materials: UML

Evaluation Method: The user will see the changes made on the Calendar page

Revision History: Joseph Burfield, 09/12/2014

No: 4

Statement: The user shall be able to look at the suggestions the software produces, rate them, and insert them into their calendar.

Source: Creation of a new profile and adding events to the user's calendar

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: The user will see the changes in suggestions page

Revision History: Joseph Burfield, 09/12/2014

3.2 Interface Requirements:

No: 5

Statement: The user shall have a specific interface for the user to easily go to their profile, calendar, and suggestions, and make changes as they see fit

Source: User Interface

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Testing the capabilities of the interface

Revision History: Joseph Burfield, 09/12/2014

3.3 Physical Environment Requirements:

No: 6

Statement: The user shall be able to access their software from a modern PC with either the Windows 7 or 8 Operating system, or the current Mac OS.

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Using a wide range of PCs to make sure the application runs smoothly

Revision History: Joseph Burfield, 09/12/2014

3.4 Users and Human Factors Requirements:

No: 7

Statement: The system shall require its users to have only the documentation that comes with the applciation.

Source: Documentation

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Proofreading documentation and getting feedback from client

Revision History: Joseph Burfield, 09/12/2014

No: 8

Statement: The system shall provide its users special accommodations such as larger font sizes and a neutral color scheme for those that are color blind.

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 9

Statement: The system shall maintain its own independent copy of the database and the software so that no private information between other users is jeopardized

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

3.5 Documentation Requirements:

No: 10

Statement: The user shall have access to the documentation through the application.

Source: Documentation and Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 11

Statement: The user is assumed to have a skill level of novice with minimal computer experience

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

3.6 Data Requirements:

No: 12

Statement: The system shall retain all data of the user's profile for personalization of notifications and specializing the suggestions.

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 13

Statement: The system shall retain all ratings of the suggestions made by the user and data taken from the events created by the user, to personalization of notifications and specializing the suggestions

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

3.7 Resource Requirements:

No: 14

Statement: Software Engineers to maintain the system

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 15

Statement: The system will utilize the following software and tools:

C# and .NET

MySQL

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

3.8 Security Requirements:

No: 16

Statement: The system shall be independent from other systems so information is accessible only from the user who produced the information

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 17

Statement: The system shall backup its data once every 5 minutes the application is running in case of the computer or application shutting down inadvertently

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

3.9 Quality Assurance Requirements:

No: 18

Statement: The system will be available 100% of the time so long as the user's PC and/or files remain original and operational.

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 19

Statement: The system shall be reliable to notify the user 99.99% of the time of their upcoming events on time

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

No: 20

Statement: The system shall receive updates to upkeep and improve the quality of the suggestions and the application itself

Source: Application

Dependency: None

Conflicts: None

Supporting Materials: UML

Evaluation Method: Getting feedback from the client

Revision History: Joseph Burfield, 09/12/2014

SECTION 4: Supporting Material

None

Template created by G. Walton (GWalton@mail.ucf.edu) on Aug 30, 1999 and last updated Aug 15, 2000

This page last modified by Joseph Burfield (jburfield@knights.ucf.edu) on September, 17, 2014