17
Software Requirements Specification for Taylor’s Instant Notification System (INS) Version 1.00 Prepared by Group Name: N & L Corporation Liew Soon Hen 0315575 [email protected] Ng Beng Han 0319496 [email protected] Instructor: Azween Abdullah Course: Software Process Lab Section: Teaching Assistant: Date: 08 April 2015

Taylor's INS SRS

Embed Size (px)

DESCRIPTION

Software Requirement Specification for Taylor's Instant Notification Specification

Citation preview

  • Software Requirements Specification

    for

    Taylors Instant Notification System (INS)

    Version 1.00

    Prepared by

    Group Name: N & L Corporation

    Liew Soon Hen 0315575 [email protected]

    Ng Beng Han 0319496 [email protected]

    Instructor: Azween Abdullah

    Course: Software Process

    Lab Section:

    Teaching Assistant:

    Date: 08 April 2015

  • Software Requirements Specification for Page ii

    Contents

    CONTENTS ........................................................................................................................................................................ II

    REVISIONS...................................................................................................................................................................... III

    INTRODUCTION ............................................................................................................................................................... 1

    DOCUMENT PURPOSE ........................................................................................................................................................ 1

    PRODUCT SCOPE................................................................................................................................................................ 1

    INTENDED AUDIENCE AND DOCUMENT OVERVIEW .......................................................................................................... 2

    DEFINITIONS, ACRONYMS AND ABBREVIATIONS .............................................................................................................. 2

    DOCUMENT CONVENTIONS ............................................................................................................................................... 3

    REFERENCES AND ACKNOWLEDGMENTS ................................................................. ERROR! BOOKMARK NOT DEFINED.

    OVERALL DESCRIPTION ............................................................................................................................................. 4

    PRODUCT PERSPECTIVE ..................................................................................................................................................... 4

    PRODUCT FUNCTIONALITY ................................................................................................................................................ 5

    USERS AND CHARACTERISTICS ......................................................................................................................................... 6

    OPERATING ENVIRONMENT ............................................................................................................................................... 6

    DESIGN AND IMPLEMENTATION CONSTRAINTS................................................................................................................. 7

    USER DOCUMENTATION .................................................................................................................................................... 8

    ASSUMPTIONS AND DEPENDENCIES .................................................................................................................................. 8

    SPECIFIC REQUIREMENTS......................................................................................................................................... 9

    EXTERNAL INTERFACE REQUIREMENTS ............................................................................................................................ 9

    FUNCTIONAL REQUIREMENTS ......................................................................................................................................... 11

    BEHAVIOUR REQUIREMENTS ........................................................................................................................................... 12

    OTHER NON-FUNCTIONAL REQUIREMENTS .................................................................................................... 13

    PERFORMANCE REQUIREMENTS ...................................................................................................................................... 13

    SAFETY AND SECURITY REQUIREMENTS......................................................................................................................... 13

  • Software Requirements Specification for Page iii

    SOFTWARE QUALITY ATTRIBUTES .................................................................................................................................. 13

    OTHER REQUIREMENTS .......................................................................... ERROR! BOOKMARK NOT DEFINED.

    APPENDIX A DATA DICTIONARY ....................................................... ERROR! BOOKMARK NOT DEFINED.

    APPENDIX B - GROUP LOG....................................................................... ERROR! BOOKMARK NOT DEFINED.

    Revisions

    Version Primary Author(s) Description of Version Date Completed

    1.00 Liew Soon Hen

    Ng Beng Han

    Start-up, 00/00/00

  • Software Requirements Specification for Page 1

    Introduction

    Document Purpose

    This document describes the teams current release of Taylors INS, which is the

    teams product for this project. The version described in this document will be version 1.00.

    This document also describes the software requirements for this project on the

    application. The details for this project can be found in this document, such as the functions

    and features of the application, the interface, operation environment, and other information.

    This SRS will show the outline and all software required for this project.

    Product Scope

    Taylors INS is a mobile application that aims to notify Taylors students on recent

    developments in their course. Students can have instant access to their timetable and will

    be able to access all of Taylors announcements and alerts in their course. In the event of a

    class cancellation or an event announcement, notifications will be pushed to the students

    smart devices so that nobody misses anything.

    Taylors INS is developed for mainly students to access their academic materials and

    notices, but Taylors staff and lecturers can also use it to send notifications or make

    announcements to their students when required.

    Taylors INS will be able to be run smoothly on all smart devices, ranging from

    mobile phones to tablets. It will run perfectly on all major operating systems, including iOS

    and Android.

  • Software Requirements Specification for Page 2

    Intended Audience and Document Overview

    This document is readily perusable by the client, which is Taylors University. This

    document can also be read by developers of the team, project managers and the testers.

    This SRS starts with a declaration of the definitions of all acronyms or abbreviations that

    this document uses for better understanding. A list of document conventions will also be

    listed so that the reader knows which part is emphasized.

    Following this will be a full and detailed product description regarding this project. All

    information such as product function, characteristics, operating environment and design

    constraints will be listed down for the readers perusal.

    Next, the projects requirements will be detailed out in full for the readers examination,

    including the functional and non-functional requirements.

    The reader is advised to begin reading beginning with the document overview, followed

    by definitions of acronyms and abbreviations, followed by product descriptions and the

    project requirements. The reader can also check the appendix for extra information.

    Definitions, Acronyms and Abbreviations

    Definitions:

    PhoneGap - a free and open source framework to create mobile apps using standardized

    web APIs for the platforms

    Software Requirement Specification - a description of a software system to be developed,

    laying out functional and non-functional requirements, and may include a set of use cases

    that describe interactions the users will have with the software

    Taylors INS - a mobile application that is developed by N&L Corporation to notify Taylors

    students on recent developments in their course

    Taylors Portals a website which is developed for Taylors students to check their

    timetable, announcement, and online registration for the subject that they are taking

  • Software Requirements Specification for Page 3

    Acronyms:

    INS Instant Notification System

    SRS Software Requirement Specification

    iOS iPhone Operating System

    HTML5 Hypertext Modeling Language 5

    RAM random access memory

    FAQ Frequently asked question

    Document Conventions

    Most of the document will be written in Arial with the font size 12. The document text

    is single spaced.

    Text written in teal and bolded with font size 14 will be the titles for each individual

    subsections. Text written in dark grey boxes with Arial font size 16 will be the titles for each

    different major section.

  • Software Requirements Specification for Page 4

    Overall Description

    Product Perspective

    Taylors INS is a new and self-contained product that aims to help Taylors students

    get faster access to their timetable and their alerts and announcements. Taylors INS will

    get information and data from the existing Taylors Portals system and push the information

    into Taylors INS for the students to view. Students can open the Taylors INS application on

    their smartphone manually to view their timetable and alerts. However, what makes Taylors

    INS unique from Taylors Portals is that when a new alert or announcement is made on

    Taylors Portals, it does not notify the student until the students log in manually from an

    internet browser. Taylors INS, however, pushes any new alerts or announcement directly to

    the students smart devices, instantly notifying the student instead of waiting for the student

    to log into Taylors Portals.

    For Taylors INS to perform perfectly, the Taylors Portal will need to collaborate with

    Taylors INS and allow a connection between these two systems to be made. The student

    must be able to log into their Taylors Portals on the Taylors INS application first before a

    connection is made with Taylors Portals. Once the connection is made, Taylors Portals will

    be able to send information to Taylors INS and the application will display the information

    on the application for the students to view. The connection will be made secure and long-

    lasting, so that the student does not have to continuously log into Taylors Portals through

    the Taylors INS application to get more information.

  • Software Requirements Specification for Page 5

    Product Functionality

    Students will be able to check their timetable instantly.

    When the lecturer needs to cancel his classes with his students, the lecturer can use

    the application to send a notice to all students.

    Alert students when assignment due dates are near.

    Any important announcements made by the school or the lecturers of the student will

    be instantly pushed to their smart devices so that they will be instantly notified.

  • Software Requirements Specification for Page 6

    Users and Characteristics

    The most important users for Taylors INS will be the students of Taylors University.

    The students will need to constantly access information from Taylors Portals. Students can

    use the Taylors INS application to view their alerts, timetables, and announcements.

    The second user of this application will be the lecturers of Taylors University. Should

    they unexpectedly need to cancel or postpone a class, they will be able to notify all their

    students instantly.

    One more user of this application will be the management of Taylors University. Should

    they have any programme announcements or general announcements to make to all

    Taylors students, they can do so using Taylors INS and all students will be instantly

    notified.

    Operating Environment

    Taylors INS will be able to operate in iOS 4 and above and Android 2.3 and above.

    For the hardware, Taylors INS will be able to work on an iPhone 4 and above, and smart

    devices running Android with 512MB or RAM and above.

    Taylors INS will also need a stable and secure connection to the existing Taylors

    Portals system to retrieve key information to be displayed to the users.

  • Software Requirements Specification for Page 7

    Design and Implementation Constraints

    Taylors INS requires a connection to Taylors Portals databases. In the design and

    implementation process of this application, the databases used must be able to sync with

    the Taylors databases so that the connection can be made.

    The language used for the application must be English. This is because English is

    the primary language in Taylors University and this application must be understood by all

    the students and staff in Taylors University.

    Taylors INS has a connection to the Taylors Portals. This connection has to be

    secure, because the user will only enter his password once into the application when he first

    logs in. After that, when the user opens the application again, the application will allow the

    user direct access without entering a password again. Therefore, the connection must be

    secure and information about the user must not be revealed over the network.

    Development for this application has to be done in PhoneGap, which is an open

    source framework that allows applications to be created using standardized web APIs for all

    popular mobile operating systems. This allows any future change done to the source code

    of the application to be reflected in all versions of the application so that the application

    does not need to be updated multiple times for different platforms.

    This application must be able to be made to run on older hardware so that more

    users will be able to use it. This application must be able to use on devices with 512MB of

    RAM and above. When the user is using the application, the application must not use more

    than 200MB of RAM. The application must also be able to run on operating systems as old

    as Android 2.3 Gingerbread and iOS 4. This is to allow even more users to use this

    application perfectly.

  • Software Requirements Specification for Page 8

    User Documentation

    Upon log in for the first time, the application will load a tutorial to teach the user how

    to use the application properly. The user can skip the tutorial if he or she wishes to do so. A

    help section will also be available in the application itself if the user wants to get more

    information or if he has forgotten how to do something in the application.

    A FAQ section will also be included in the help section.

    Assumptions and Dependencies

    Taylors INS is depending on Taylors Portals to get information to be displayed to its

    users. Without Taylors Portals, Taylors INS will have no source of information.

    Taylors INS also assumes that every student will have their timetable up and

    available on the Taylors Portals system.

  • Software Requirements Specification for Page 9

    Specific Requirements

    External Interface Requirements

    User Interfaces

    The user interface will begin on the home page where the user is asked to log in if

    they are opening the application for the first time. Upon log in, the user will be presented

    with his or her timetable, with three tabs on the top menu for the user to view different

    information. The three tabs will be on top the whole time the user is using it, for the

    convenience for the user to switch tabs and view different information instantly.

    There will also be a menu button on the top left of the application at all times for the

    user to access the settings for the application and also log out.

  • Software Requirements Specification for Page 10

    Hardware Interfaces

    To access a student timetable, alerts and so on, Taylors INS will need to open a

    connection to Taylors Portals. Taylors Portals will have to get the information from Taylors

    databases. When Taylors Portals transfer the information to Taylors INS, the information

    will be displayed on the students smart devices.

    Software Interfaces

    Taylors INS will maintain a continuous connection with the Taylors Portals system

    so that any alerts can be pushed to the users smart devices instantly. When an alert is

    made on Taylors Portals by a lecturer or a Taylors staff, it will be sent across to Taylors

    INS. Taylors INS will then notify the student about it. The student can also request for

    access to their timetable, which will be promptly granted after the student logs in for the first

    time on Taylors INS.

    Taylors INS will only be able to run on the major mobile operating systems, Android and

    iOS.

    Communications Interfaces

    Taylors INS will have a continuous network connection with Taylors Portals, which

    has a continuous and stable connection with Taylors databases to retrieve information

    from. The data that is sent from Taylors Portals to Taylors INS will be encrypted safely,

    with medium to high data transfers rate. The users information will not be revealed to the

    network.

    The data in Taylors Portals will be synchronized with the information in Taylors INS

    every 2 minutes. This is to ensure that the student gets the latest alerts and announcements

    made as soon as possible to prevent any unwanted misunderstandings.

  • Software Requirements Specification for Page 11

    Functional Requirements

    Students will be able to check their timetable instantly.

    Upon successful log in to Taylors INS, the student will be shown their timetables

    when they open the application. Taylors INS should have opened a connection with

    Taylors Portal and downloaded the students timetable when the student first logged

    in on Taylors INS. Every time the student opens the application, Taylors INS will

    then check with Taylors Portal to see if the timetable has been updated. If there is

    any updates, the new timetable will be downloaded and shown instead on the

    homepage of the application.

    When the lecturer needs to cancel his classes with his students, the lecturer can use

    the application to send a notice to all students.

    When he sends the notice, Taylors INS will notify all the students that the class his

    cancelled along with a short note if the lecturer wishes. This will reduce the impact of

    the class cancellation if the notice was given early enough.

    Alert students when assignment due dates are near.

    This will serve as a reminder when the student has forgotten that a due date for one

    of his assignment draws near.

    Any important announcements made by the school or the lecturers of the student will

    be instantly pushed to their smart devices so that they will be instantly notified.

    Similarly, when a Taylors staff or Taylors management have important

    announcements to be made, they can make it as usual on the Taylors Portal and

    Taylors INS will automatically retrieve it and push it to all students smart devices so

    that they can be instantly notified of the announcement.

  • Software Requirements Specification for Page 12

    Behaviour Requirements

    Use Case View

  • Software Requirements Specification for Page 13

    Other Non-functional Requirements

    Performance Requirements

    When the user first opens the application, he or she is required to login for the first

    time. This login must not take longer than 10 seconds. This is because the student may be

    hard pressed for time and need to check their timetable urgently.

    The synchronization process between Taylors Portals and Taylors INS must be

    instant and continuous. This is because if there is a new update on Taylors Portals, the

    student must receive it instantly on Taylors INS.

    When the user opens the app and switches between different tabs to view different

    information, the information should be displayed instantly without any hiccups or stutters.

    This is because the information from Taylors Portals should already be downloaded in the

    background so that the information is readily available for viewing when the user opens the

    application.

    When a new notice or announcement is received on Taylors Portals, the information

    must be pushed instantly to the students device. This is to allow the students to be able to

    make necessary scheduling based on the new information.

    When adding a new assignment to the students Assignments tab, the whole

    process should not take longer than 20 seconds. The adding process should be as

    convenient and efficient as possible.

    Safety and Security Requirements

    Taylors INS will be depending on an active connection with Taylors Portals at all

    times. Any information regarding the user, such as the users identity and the users

    password, must not be revealed over the network.

    Any information being transferred across from Taylors Portals to Taylors INS must

    also be encrypted and kept safe. Information such as the users timetable, alerts and notices

    sent to them must be kept encrypted.

  • Software Requirements Specification for Page 14

    Software Quality Attributes

    Reliability

    The software must be reliable. Upon opening the application, the most important

    information, which is the users timetable, will be shown. Any new updates or alerts or

    announcements will be shown immediately when Taylors INS receives it.

    Robustness

    When the user logs in for the first time, when he enters the wrong username or password,

    the application will reject it and prompt the user to try again. The servers from Taylors

    Portals will be synchronized perfectly with Taylors INS so that all alerts and

    announcements can be sent with no problems.

    Portability

    Taylors INS will be able to be used on the major mobile operating systems, Android and

    iOS, with support for other operating systems coming soon. The development of this system

    should be carried out with PhoneGap, which allows a single version of the code to be able

    to be used with different operating systems.