Addis Ababa Institute of Technology Center of Information Technology and Scientific Computing Department of Software Engineering
Addis Ababa Institute of Technology Center of Information Technology and Scientific Computing Department of Software Engineering
Team Members
Kiberleab Eniyew
Henok Addis meles
Mathis Birhane
Habib Jemal
April 2018
Software Requirement Specification for A Communication and
Collaboration tool
Revision History
Document Approval
The following Software Requirements Specification has been accepted and approved by the
following:
Table Of Contents
Revision History............................................................................................................................................ii
Document Approval......................................................................................................................................ii
List of Tables.................................................................................................................................................v
Table of Figures...........................................................................................................................................vi
ABBREVIATIONS...........................................................................................................................................2
DECLARATION...............................................................................................................................................3
1. INTRODUCTION .....................................................................................................................................1
1.1. PURPOSE .......................................................................................................................................1
1.2. SCOPE............................................................................................................................................1
1.3. OVERVIEW ....................................................................................................................................2
2. GENERAL DESCRIPTION .........................................................................................................................3
2.1. PRODUCT PRESPECTIVE ................................................................................................................3
2.2. PRODUCT FUNCTION ....................................................................................................................3
2.3. USER CHRACTERSTICS ...................................................................................................................4
2.4. GENERALCONSTRAINTS................................................................................................................4
2.5. ASSUMPTION AND DEPENDANCIES ..............................................................................................5
3. SPECFIC REQUIRMENTS ........................................................................................................................5
3.1. External Interface Requirements ..................................................................................................5
3.1.1. Users
Interface...................................................................................................................... 5
3.1.1.1. User Interface flow
Diagram ................................................................................................ 5
3.1.1.2. User
Interfaces ............................................................................................................
......... 7
Log in page ....................................................................................................................................8
Student’s Home Page ....................................................................................................................9
Teacher’s Home Page..................................................................................................................10
Admin Home Page.......................................................................................................................11
References ..................................................................................................................................................
31
List of Tables
Table 1: Functional Requirement 01 ...........................................................................................................
13
Table 2: Functional Requirement 02 ...........................................................................................................
13
Table 3:Functional Requirement 3 ..............................................................................................................
13
Table 4:Functional Requirement 4 ..............................................................................................................
14
Table 5: Functional Requirement 5 .............................................................................................................
14
Table 6:Give Assessment ............................................................................................................................ 15
Table 7:Submit Group .................................................................................................................................
15
Table 8:UC-01 View Information................................................................................................................. 18
Table 9:UC-02:Reset Password ...................................................................................................................
19
Table 10:UC-03 Post Information ............................................................................................................... 20
Table 11: UC-04 Download Resource ......................................................................................................... 21
Table 12:UC-05: Upload Resources .............................................................................................................
22
Table 13:UC-01: Give Assessment .............................................................................................................. 23
Table 14:UC-07: Submit Group ...................................................................................................................
24
Table 15:UC-08: Send Assessment ..............................................................................................................
25
Table 16:UC-09: Submit Assessment ..........................................................................................................
26
Table 17:Non-Functional Requirement....................................................................................................... 27
Table 18:Logical Database .......................................................................................................................... 28
Table of Figures
Figure 1: Teacher’s User Interface Flow Diagram .........................................................................................
6
Figure 2: Student’s User Interface Flow Diagram .........................................................................................
7
Figure 3:Log in Page ......................................................................................................................................
8
Figure 4:Student's Home Page ......................................................................................................................
9
Figure 5:Teacher's Home page.................................................................................................................... 10
Figure 6:Admin's Home page ......................................................................................................................
11
Figure 7:Sign Up page .................................................................................................................................
12 Figure 8:ER-
Diagram ................................................................................................................................... 29
ABBREVIATIONS
DECLARATION
We declare that this written submission represents our ideas in our own words and where others’ ideas or
words have been included. We have adequately cited and referenced the original sources. We also declare
that we have adhered to all principles of academic honesty and integrity and have not misrepresented or
fabricated or falsified any idea/data/fact/source in our submission. We understand that any violation of the
above will be cause for disciplinary action by the Institute and can evoke penal action from the sources
which have thus not been properly cited or from whom proper permission has not been taken when needed.
Page|
1.INTRODUCTION
1.1.PURPOSE
This document provides a complete description of all the functions and specifications of the
system “Communication and Collaboration Tool”. It will illustrate the purpose and
functionality of the development of the system. It will also explain the user interface, system
constraint, the error handling and the quality of the system. The expected audience of this
document is the Community of AAiT.
1.2.SCOPE
The system will be first deployed on AAiT but we are hoping to have a wider
geographical service and more users. The system that is going to be implemented has
different, and unique features that are going to designed to satisfy the user as much as
possible :
• The system we are building lets students and teachers to login if already register (if
not, register then login) to their perspective accounts after they are login they will
get different services. In both cases the wall module will come first and then they
choose where to go next.
• The Wall module: This module lets students view different walls to see new
information these walls include, department, class, teachers and projects. They can
check every wall by going through them and as will post different information on
which they are authorized to. This walls also let students to check, view and
download resources.
• The assessment module: In this module students can see progress of their project
and assignment, send project to teacher and advisor for assessment and submit.
They also receive new projects or\and assignments from teachers and this module
also lets them choose and invite group members to work with and join if they are
invited.
• The customize module: This module include services that help students customize
their account for better comfort and less disturbance.
• Resource and information module: This lets them post, upload and view
information and resource to authorized walls.
• Assessment module: This module lets them give new project and assignment,
approve group membership (optional), view and comment on progress, shift
deadlines and accept submission and give grades.
1.3.OVERVIEW
This remainder of this document has three chapters, the first providing a full
description of the project. It lists all the functions performed by the system. In the
second chapter there are some details about the system functions and actions in
full for the developers’ assistance. Lastly it indicates change management process.
2. GENERAL DESCRIPTION
2.1.PRODUCT PRESPECTIVE
2.2.PRODUCT FUNCTION
This communication and collaboration tools has three different types of users.
While there is no restriction to be in more than one side. The functionalities of the
system and level of authorization over data depends on who is clicking the login
button.
First there is authoritarian of the system, is the admin with powers from deleting
any account to give approval for a sign up of a teacher account.
The second inline are the Teachers, in this system the teachers are provided with
functionalities like giving assessment, reviewing assessment and sharing
information and resource as well.
There are three types of users that interact with the system: teachers, students and
administrators. Each of these three types of users has different use of the system
so each of them has their own requirements.
The teacher users can use the application to send and receive data. This means that
the user has to be able to give assessments, to post information and upload
resources, to review and assessments projects and to send grades to their students.
This user should be familiar with basic knowledge of surfing the web.
For this user to get a relevant access to these services there are multiple criteria the
users must fulfill. The most important thing is that, the user must have legal AAiT
teacher’s username and account.
The student user will not use the teacher page but the student page instead. And
then they will share the information about their course, for example view posted
information, download Resources, Submit Assessments and projects, to request
Reviews and to post information. This user also should have a basic computer
interaction skill.
The administrators also only interact with the web portal. They are managing the
overall system so there is no intruder in it. The administrator can manage the
account and the information for each user while keeping the privacy of the users.
This user should have a minimum technical expertise of managing databases.
2.4.GENERAL CONSTRAINTS
One assumption about the product is that it will require hardware and software
application for the system to run with enough performance. Then the system will
need desktop or personal computer to run and database connection to fetch data
from server to client computer.
3.SPECFIC REQUIRMENTS
3.1.External Interface Requirements
3.1.1.Users Interface
3.1.1.1. User Interface flow Diagram
Sign up page
3.2.Functional Requirements
Level User
Level User
User is on the login page
Precondition
UC-03: PostInformation
UC-04: DownloadResources
Failure End The student not submits group name and group mem
Trigger The student login in to the system
Main success scenario 1. The user selects Assessments
2. The system displays all available
3. assessments including new assessments
4. The user selects an assessment
5. The system displays all information about
6. Theselected assessment
7. The user selects create group
8. The system display chose members
9. from available members
10. The user selects individuals to his/her group
11. and enter group name
12. The user selects create My group
13. The system displays conformation
14. The System displays submit group page
15. The user selects submit group
16. The system submits the group
Level User
Precondition The student is on the login page
Success End The student send Assessment for a Review
Failure End The student not send Assessment for a Review
Trigger The student login in to the system
Main success scenario 1. The user selects Assessments
2. The system displays all available
3. assessments including new assessments
4. The user selects an assessment
5. The system displays all information about
6. the selected assessment
7. The user selects send for Review
8. The system displays file chooser
9. The user selects a file from his/her local Machine
10. The user selects send for review
11. The system starts sending for Review for the
12. teacher who give the assessment with follow
up information’s of the group
Extensions(Error scenario) 5a. The teacher Mark the Assessment as “No Assistant”
5a.1. The system displays the Error information
5a.2. The users resumes at 4
Level User
Precondition The student is on the login page
Success End The student Submit Assessment
Failure End The student not Submit Assessment
Trigger The student login in to the system
Main success scenario 1. The user selects Assessments
2. The system displays all available
assessmentsincluding new assessments
3. The user selects an assessment
4. The system displays all information about
the selected assessment
5. The user selects submit Assessment
6. The system displays file chooser
7. The user selects a file from his/her local machine
8. The user selects submit
9. The system verifies it is before the deadline
10. The system starts submitting the assessment for
Non-Functional Requirements
Usability
The user interface of the system should be easy to use so as any AAIT student will use it without any
problem. Formal language and familiar words will be used for developing the system.
Portability
The system will be multi-platform compatible to be accessed from mobile phones and personal
computers. There is no need of installation for this software.
Security
The system shall protect the privacy of each user by forbidding access if the user fails to provide the
correct login information. If a user forgot the password, he/she can change the password by email to
recover his account.
Performance
The response time in changes must be done quickly and efficiently. It must not exceed 1-2 seconds for
big networks.
Maintainability
To ensure maintainability of the system the program will be written fine grained to pinpoint errors and
ease debugging. Comments are provided alongside the code for common understanding.
Despite the massive functionality of the system, there are some things that should left in
the old way. For instance, the system do not offer any suggestion about assessment
deadline or grading or anything that is related or indicative to how the teacher do their
job.
Although the system is going to be designed for helping students achieve their best in
their work and accomplish great things in their particular field, but still the system
does not provide any help of academics for students of any kind.
Intuitiveness
The interface of the system should be least astonishing to lower the learning
curve for users in order to generate positive emotions of users.
Platform Supportability
Because the system has cross platform characteristic, the implementation must
be compatible with personal computer and mobile devices to widen reach.
Figure 8:ER-Diagram
impact on the implementation and the affordability of the cost of the change
and if the change is worthy of it, it is implemented.
References
1.about piazza, http://support.piazza.com/, April 2018