You are on page 1of 12

Marvel Electronics and Home Entertainment

Sickolo App
Software Requirements Specification
Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

Revision History
Date Version Description Author
07/31/21 1.0 Original Doc creation Romain Ndoutoume

Confidential ©<Company Name>, 2021 Page 2


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

Table of Contents
1. .................................................................................................................................................................... Introduction
.........................................................................................................................................................................................5
1.1 ................................................................................................................................................................Purpose
................................................................................................................................................................................5
1.2 ................................................................................................................................................................... Scope
................................................................................................................................................................................5
1.3 ................................................................................................................................ Definitions, Acronyms, and
Abbreviations .........................................................................................................................................................6
1.4 ........................................................................................................................................................... References
................................................................................................................................................................................6
1.5 ............................................................................................................................................................. Overview
................................................................................................................................................................................6

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

3. ...................................................................................................................................................................... Functional
Requirements...................................................................................................................................................................6
3.1 ....................................................................................................................................................... Functionality
................................................................................................................................................................................7
3.1.1 Post, remove and search a question. ...................................................................................................7
3.1.1.1 ...................................................................................The system shall allow students to post a question.
.............................................................................................................................................................................7
3.1.1.2 ....................................... The system shall allow students to search for a question with given keywords.
.............................................................................................................................................................................7
3.1.1.3 ....................................................................... The system shall allow admin users to remove a question.
.............................................................................................................................................................................7
3.1.1.4 The system shall allow students and professors to reply to comments (shall not allow reply to a reply).
.............................................................................................................................................................................7
3.1.1.5 .....................................................The system shall allow students and professors to reply to a question.
.............................................................................................................................................................................7
3.1.2 Endorse an answer..............................................................................................................................7
3.1.3 Join, create, and remove a class .........................................................................................................7
3.1.3.1 ......................................................................................... The system shall allow students to join a class.
.............................................................................................................................................................................7
3.1.3.2 ............................................................................... The system shall allow admin users to create a class.
.............................................................................................................................................................................7
3.1.3.3 ............................................................................. The system shall allow admin users to remove a class.
.............................................................................................................................................................................7
3.1.4 Third party Whiteboard Integration ...................................................................................................6
3.1.4.1 .......... The system shall be able to integrate third party virtual whiteboard collaboration app: Ziteboard
.............................................................................................................................................................................6
3.1.4.2 ............................The system shall allow students and professors to join and use the virtual whiteboard
.............................................................................................................................................................................6
3.1.5 Question thread...................................................................................................................................8
3.1.6 Question Feed Page ............................................................................................................................8

4. .............................................................................................................................................................. Non-Functional
Requirements...................................................................................................................................................................9

Confidential ©<Company Name>, 2021 Page 3


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

4.1 .............................................................................................................................................................. Usability


................................................................................................................................................................................9
4.1.1 Graphical User Interface ....................................................................................................................9
4.1.2 Accessibility .......................................................................................................................................9
4.2 ........................................................................................................................................................Reliability &
Availability .............................................................................................................................................................9
4.2.1 Back-end Internal Computers.............................................................................................................9
4.2.2 Internet Service Provider ....................................................................................................................9
4.3 ........................................................................................................................................................ Performance
..............................................................................................................................................................................10
4.4 ............................................................................................................................................................... Security
..............................................................................................................................................................................10
4.4.1 Data Transfer ....................................................................................................................................10
4.4.2 Data Storage .....................................................................................................................................10
4.5 ......................................................................................................................................................Supportability
..............................................................................................................................................................................11
4.5.1 Configuration Management Tool .....................................................................................................11
4.6 ................................................................................................................................................................. Design
Constraints ............................................................................................................................................................11
4.6.1 Standard Development Tools ...........................................................................................................11
4.6.2 Web Based Product ..........................................................................................................................11
4.7 ..................................................................................................On-line User Documentation and Help System
Requirements ........................................................................................................................................................11
4.8 ............................................................................................................................................................ Purchased
Components ..........................................................................................................................................................11
4.9 ............................................................................................................................................................. Interfaces
..............................................................................................................................................................................11
4.9.1 User Interfaces..................................................................................................................................11
4.9.2 Hardware Interfaces .........................................................................................................................11
4.9.3 Software Interfaces ...........................................................................................................................12
4.9.4 Communications Interfaces ..............................................................................................................12
4.10 ........................................................................................................................................................... Licensing
Requirements ........................................................................................................................................................12
4.11 ............................................................................................................................. Legal, Copyright, and Other
Notices ..................................................................................................................................................................12
4.12 ......................................................................................................................................................... Applicable
Standards ..............................................................................................................................................................12

5. ...................................................................................................................................................................... Supporting
Information ....................................................................................................................................................................12

Confidential ©<Company Name>, 2021 Page 4


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

Software Requirements Specification


1. Introduction

The introduction of the Software Requirements Specification (SRS) provides an overview of the
entire SRS with purpose, scope, definitions, acronyms, abbreviations, references and overview of
the SRS. The aim of this document is to gather and analyze and give an in-depth insight of the
complete Sickolo App by defining the problem statement in detail. Nevertheless, it also
concentrates on the capabilities required by stakeholders and their needs while defining high-
level product features. The detailed requirements of the Sickolo App are provided in this
document.

1.1 Purpose

The purpose of the document is to collect and analyze all assorted ideas that have come up to
define the system, its requirements with respect to consumers. Also, we shall predict and sort out
how we hope this product will be used in order to gain a better understanding of the project,
outline concepts that may be developed later, and document ideas that are being considered, but
may be discarded as the product develops.

In short, the purpose of this SRS document is to provide a detailed overview of our software
product, its parameters and goals. This document describes the project's target audience and its
user interface, hardware and software requirements. It defines how our client, team and audience
see the product and its functionality. Nonetheless, it helps any designer and developer to assist in
software delivery lifecycle (SDLC) processes.

1.2 Scope

Primarily, the scope pertains to the Sickolo App. The software focuses on the ability for high
school students and college students to get unstuck anytime and anywhere in their coursework by
asking questions on the platform. A student can ask a question directly to the professor or the
classmates in order to get help. The professor or the classmates can respond to the question if
they know the answer to the question. The students and professor can also go to the virtual
collaborative whiteboard to get interact with the students.

This SRS is also aimed at specifying requirements of software to be developed but it can also be
applied to assist in the selection of in-house and commercial software products. The standard can
be used to create software requirements specifications directly or can be used as a model for
defining a organization or project specific standard. It does not identify any specific method,
nomenclature or tool for preparing an SRS.

Confidential ©<Company Name>, 2021 Page 5


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

1.3 Definitions, Acronyms, and Abbreviations

App Application
Admin An individual or group of people responsible to manage the subscription plan of a given
institution.
Professor Instructor of a given course.

1.4 References

1.5 Overview

The remaining sections of this document provide a general description, including characteristics
of the users of this project, the product's hardware, and the functional and data requirements of
the product. General description of the project is discussed in section 2 of this
document. Section 3 gives the functional requirements, data requirements and constraints and
assumptions made while designing the Sickolo App. It also gives the user viewpoint of
product. Section 3 also gives the specific requirements of the product. Section 3 also discusses
the external interface requirements and gives detailed description of functional requirements.
Section 4 is for supporting information.

2. Overall Description

This document contains the problem statement that the current system is facing which is
hampering the growth opportunities of the company. It further contains a list of the stakeholders
and users of the proposed solution. It also illustrates the needs and wants of the stakeholders that
were identified in the brainstorming exercise as part of the requirements workshop. It further lists
and briefly describes the major features and a brief description of each of the proposed system.

The following SRS contains the detail product perspective from different stakeholders. It
provides the detail product functions of E-Store with user characteristics permitted constraints,
assumptions and dependencies and requirements subsets.

3. Functional Requirements

The specific requirements are –

Confidential ©<Company Name>, 2021 Page 6


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

3.1 Functionality

3.1.1 Post, remove and search a question.

3.1.1.1 The system shall allow students to post a question.


3.1.1.2 The system shall allow students to search for a question with given keywords.
3.1.1.3 The system shall allow professor to remove a question.
3.1.1.4 The system shall allow students and professors to reply to comments (shall not allow
reply to a reply).
3.1.1.5 The system shall allow students and professors to reply to a question.
3.1.2 Endorse an answer

The system shall allow the professor to endorse only one answer.

3.1.3 Join, create, and remove a class

3.1.3.1 The system shall allow students to join a class.


3.1.3.2 The system shall allow professors to create a class.
3.1.3.3 The system shall allow professors to remove a class.

3.1.4 Third party Cloud File Storage Integration

3.1.4.1 The system shall be able to integrate with Google Drive to upload files
3.1.4.2 The system shall be able to integrate with Office 365 to upload files

3.1.5 Notification thread

The system shall display notification thread on the dashboard

The system should alert a student when there is a new event (new question, answer, message...)

Confidential ©<Company Name>, 2021 Page 7


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

3.1.6 Question thread

The system shall display the question and the answers.

The system shall highlight the correct answer endorsed by the professor.

3.1.7 Messaging thread

The system shall display student’s messages

The system shall allow students to create group chat with one or more people including the
professor

The system shall allow students to withdraw from a group.

3.1.8 Question Feed Page

The system shall allow users to filter post based on categories (like exam, homework...)

The system shall have default categories (exam, quizzes, homework).

The system shall allow professors to customize categories (add and remove categories).

The system shall display number of online students

The system shall allow professor to view top student who responded the most

The system shall allow professor to view top student who asked the most questions

The system shall allow professor to view top student who received the most endorsement

The system shall set a question post as unresolved if a it has not been resolved.

The system shall allow professors to schedule a post/note for a given date and/or time.

3.1.9 Third party Whiteboard Integration

3.1.9.1 The system shall be able to integrate third party virtual whiteboard collaboration app:
Ziteboard
3.1.9.2 The system shall allow students and professors to join and use the virtual whiteboard
3.1.9.3 The system shall allow students and professors to automatically log in with their same

Confidential ©<Company Name>, 2021 Page 8


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

Sickolo account to the virtual whiteboard


3.1.9.4 The system shall allow students to join whiteboard within their group message.
3.1.9.5 The system shall give professors the flexibility to make the virtual whiteboard open for
the whole class within a given period of time (mostly for office hours). Professor control when
the class whiteboard is available or not.

3.1.10 Profile

The system shall allow students and professors to select profile pictures or upload a picture.

The system shall allow students to gain points.

The system shall not allow other students to see another student’s points

The system shall allow professors only to see all the students points with their name based on
their interaction within the platform.

4. Non-Functional Requirements

4.1 Usability

4.1.1 Graphical User Interface

The system shall provide a uniform look and feel between all the web pages.

The system shall provide a digital image for each product in the product catalog.

The system shall provide use of icons and toolbars.

4.1.2 Accessibility

The system shall provide multi language support.

4.2 Reliability & Availability

4.2.1 Back-end Internal Computers

4.2.2 Internet Service Provider

The app shall be web based with 99.9999% availability.

Confidential ©<Company Name>, 2021 Page 9


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

4.3 Performance

The product shall be based on web and has to be run from a web server.

The product shall take initial load time depending on internet connection strength which also
depends on the media from which the product is run.

The performance shall depend upon hardware components of the user.

4.4 Security

4.4.1 Data Transfer

The system shall use secure sockets in all transactions that include any confidential customer
information.

The system shall automatically log out all customers after a period of inactivity.

The system shall confirm all transactions with the customer’s web browser.

The system shall not leave any cookies on the customer’s computer containing the user’s
password.

The system shall not leave any cookies on the customer’s computer containing any of the user’s
confidential information.

4.4.2 Data Storage

The customer’s web browser shall never display a customer’s password. It shall always be
echoed with special characters representing typed characters.

The customer’s web browser shall never display a customer’s credit card number after retrieving
from the database. It shall always be shown with just the last 4 digits of the credit card number.

The system’s back-end servers shall never display a customer’s password. The customer’s
password may be reset but never shown.

The system’s back-end servers shall only be accessible to authenticated administrators.

The system’s back-end databases shall be encrypted.

Confidential ©<Company Name>, 2021 Page 10


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

4.5 Supportability

4.5.1 Configuration Management Tool

The source code developed for this system shall be maintained in configuration management
tool.

4.6 Design Constraints

4.6.1 Standard Development Tools

The system shall be built using a standard web page development tool that conforms to either
IBM’s CUA standards or Microsoft’s GUI standards.

4.6.2 Web Based Product

There are no memory requirements


The computers must be equipped with web browsers such as Internet explorer.
The product must be stored in such a way that allows the client easy access to it.
Response time for loading the product should take no longer than five minutes.
A general knowledge of basic computer skills is required to use the product

4.7 On-line User Documentation and Help System Requirements

4.8 Purchased Components

Not Applicable

4.9 Interfaces

4.9.1 User Interfaces

The user interface for the software shall be compatible to any browser such as Internet
Explorer, Mozilla or Netscape Navigator by which user can access to the system.
The user interface shall be implemented using any tool or software package like Java
Applet, MS Front Page, EJB etc.

4.9.2 Hardware Interfaces

Confidential ©<Company Name>, 2021 Page 11


Sickolo App Version: 1.0
Software Requirements Specification Date: 7/31/2021
Romain Ndoutoume

4.9.3 Software Interfaces


The system shall be able to connect with third party vendors and APIs.

4.9.4 Communications Interfaces

4.10 Licensing Requirements

Not Applicable

4.11 Legal, Copyright, and Other Notices

4.12 Applicable Standards


This app is for users in educational systems like high schools, colleges and universities.

5. Supporting Information

Confidential ©<Company Name>, 2021 Page 12

You might also like