Software Requirements Specification

Project:
Software for Academic
Course Management (SOGECU)

January 2019
Instructions for using this format
This format is a template for software requirements documents.

It is based on and complies with IEEE Std 830-1998.

Sections that are not considered applicable to the system described may, with justification,
be indicated as not applicable (NA).

Grades:
Texts in blue are indications that must be removed and, where appropriate, replaced by the
contents described in each section.

Texts in brackets such as “[Insert text here]” allow the direct inclusion of text with the
appropriate color and style for the section, by clicking on them with the mouse pointer.

The titles and subtitles of each section are defined as MS Word styles, so that their
consecutive numbering is automatically generated depending on whether they are “Title1,
Title2 and Title3” styles.

Indentation of texts within each section is automatically generated by pressing Enter at the
end of the title line. (Normal Indented 1, Normal Indented 2, and Normal Indented 3 styles).

The document index is a table of contents that MS Word updates based on the document's
titles.
Once you have finished writing it, you must tell Word to update all of its content to reflect the
final content.
Document information

Date Revision Author Verified dep. Quality.

23-
February- 1 German Rodriguez Bermudez No
2019
 Software Requirements Specification P. 4

Content
Instructions for using this format.............................................................................................2
Document information.............................................................................................................3
Content.....................................................................................................................................4
1 Introduction......................................................................................................................6
1.1 Purpose......................................................................................................................6
1.2 Scope.........................................................................................................................6
1.3 Staff involved............................................................................................................6
1.4 Definitions, acronyms and abbreviations..................................................................6
1.5 References.................................................................................................................6
1.6 Summary...................................................................................................................7
2 Overview..........................................................................................................................7
2.1 Product Outlook........................................................................................................7
2.2 Product Functionality................................................................................................7
2.3 User characteristics...................................................................................................7
2.4 Restrictions...............................................................................................................8
2.5 Assumptions and dependencies................................................................................8
3 Specific requirements.......................................................................................................8
3.1 Common interface requirements.............................................................................16
3.2 Functional requirements..........................................................................................17
3.2.1 Functional requirement 1.................................................................................17
3.2.2 Functional requirement 2......................................................................................17
3.2.3 Functional requirement 3.................................................................................17
3.2.4 Functional requirement 4.................................................................................17
3.2.5 Functional requirement 5.................................................................................17
3.2.6 Functional requirement 6.................................................................................18
3.2.7 Functional requirement 7.................................................................................18
3.2.8 Functional requirement 8.................................................................................18
3.2.9 Functional requirement 9.................................................................................18
3.3 Non-functional requirements.......................................................................................19
3.3.1 Performance Requirements..............................................................................19
3.3.2 Security............................................................................................................19
3.3.3 Reliability........................................................................................................19
3.3.4 Availability......................................................................................................19
Software Requirements Description
 Software Requirements Specification P. 5

3.3.5 Maintainability.................................................................................................19
3.3.6 Portability........................................................................................................19
1.1

3.3.1 Performance Requirements 17

3.3.2 Security 18
3.3.3 Reliability 18
3.3.4 Availability 18
3.3.5 Maintainability 18
3.3.6 Portability 18

Software Requirements Description

 Software Requirements Specification P. 6

1 Introduction
This document is a Software Requirements Specification (ERS) for the SOGECU System
(Software for Academic Course Management). This specification has been structured based on
the guidelines given by the IEEE standard Recommended Practice for Software Requirements
Specifications ANSI/IEEE 830, 1998.

1.1 Purpose
The purpose of this document is to define the functional and non-functional specifications for
the development of an information system that will allow the control of the academic activities
of the teacher per semester. This will be used by teachers and students.

1.2 Scope
This requirement specification is aimed at the system user, to continue with the development
of educational applications on the institution and to further its automation, which has as its
main objective the management of the different academic processes carried out by the
teachers.

1.3 Staff involved

Name German Rodriguez Bermudez
Role Analyst, designer and programmer
Professional Category Master of Computer Science
Responsibility
SOGECUI information analysis, design and programming
Contact information [email protected]

1.4 Definitions, acronyms and abbreviations

Name Description
User Person who will use the system to manage processes
SOGECU Software for the Management of Academic Courses
ERS Software Requirements Specification
RF Functional Requirement
RNF Non-functional requirement
FTP File Transfer Protocol
APP Software application running on a mobile device

1.5 References

Title of Document Reference

Software Requirements Description

 Software Requirements Specification P. 7

IEEE Standard 830 - 1998 IEEE

1.6 Summary
This document consists of three sections. The first section introduces the system and
provides an overview of the system resource specification.

The second section of the document provides a general description of the system, in order to
understand the main functions that it must perform, the associated data and the factors,
restrictions, assumptions and dependencies that affect development, without going into
excessive detail.

Finally, the third section of the document is the one in which the requirements that the system
must satisfy are defined in detail.

2 Overview

2.1 Product Outlook

The SIS-I system will be a product designed to work in WEB environments and through a
mobile application, which will allow teachers to control the most important academic activities
of their groups and subjects, such as attendance control, weighting of each unit by subject and
by students, control of the portfolio of evidence per unit of each subject and use of reports in
the formats established in the institution.

2.2 Product Functionality

The Use Case Diagram will be developed in unit 4

2.3 User characteristics

User type Administrator
Training Software Development Engineer or similar
Activities Control and management of the system in general

User type Teacher

Training Educator
Activities Using the application

User type Student

Training College student
Activities Register for the subject/group, check grades

Software Requirements Description

 Software Requirements Specification P. 8

2.4 Restrictions
• Interface to be used with the Internet.
• Using mobile app
• Languages and technologies in use: HTML, JAVA, PHP.
• Servers must be able to serve queries concurrently.
• The system will be designed according to a client/server model.
• The system must have a simple design and implementation, independent of the
platform or programming language.
.

2.5 Assumptions and dependencies

• The requirements described here are assumed to be stable.
• The equipment on which the system is to be executed must meet the requirements
indicated above to ensure correct execution of the same.

3 Specific requirements

Functional Requirements
Requirement RF01
Identification:
Name of the User Authentication.
Request:
Characteristics:
Users must identify themselves to access any part of the system.
Requirement The system can be consulted by any user depending on the module they
description: are in and their level of accessibility.
Non-functional
requirement: • RNF01
• RNF02
• RNF05
Priority of the requirement:
High

Requirement RF02
Identification:
Name of the Register Users.
Request:
Characteristics:
Users must register in the system to access any part of the system.
Requirement The system will allow the user (student, teacher and Administrator) to
description: register. The user must provide data such as: ID, Name, Surname, Email,
Username and Password.
Non-functional
requirement: • RNF01
• RNF02

Software Requirements Description

 Software Requirements Specification P. 9

• RNF05
•
Priority of the requirement: RNF08
High

Requirement RF03
Identification:
Name of the Consult Information.
Request:
Characteristics: The system will offer the teacher general information about Academic
Instruction, subjects, students and groups
Requirement View Academic Information: Displays general information about the
description: teacher's courses, enrolled students, attendance, and grades.
Non-functional
requirement: • RNF01
•
Priority of the requirement: RNF02
High

Requirement RF04
Identification:
Name of the Record data for the semester
Request:
Characteristics: The system will offer the teacher the interfaces to add the information of the
current semester: subjects, groups, units by subject,
Weightings per unit, schedules and students per subject/group
Requirement
description: Current Semester Record: Displays general information about the courses
offered by the institution, what they consist of, duration by academic period.
Non-functional
requirement: • RNF01
•
Priority of the requirement: RNF02
High

Requirement RF05
Identification:
Name of the Register students from each group
Request:
Characteristics: The system will offer the student user the possibility of registering
(enrolling) in the group.
Requirement Register students from each group: Allows students to register for the
description: subject
Non-functional
requirement: • RNF01
•
Priority of the requirement: RNF02
High
RF06 Identification

Software Requirements Description

 Software Requirements Specification P. 10

request:
Name of the Roll call of each group
Request:
Characteristics: The system will allow the teacher to take attendance by group in a more
efficient and comfortable way.
Requirement Allows the teacher to perform a roll call in each group.
description:
Non-functional
requirement: • RNF01
• RNF02
•
Priority of the requirement: RNF05
High

Requirement RF07
Identification:
Name of the Generate lists with percentage of attendance and absence by group
Request:
Characteristics: Allows you to manage information about student attendance.
Requirement Attendance and absence lists: Allows the teacher to generate attendance
description: and absence lists, also indicating the percentage of said attendance per
group.

Non-functional
requirement: • RNF01
• RNF02
• RNF05
• RNF06
•
Priority of the requirement: RNF07
High

Requirement RF08
Identification:
Name of the Allow the link between percentage of attendances and their weighting in
Request: the partial report
Characteristics: Allows you to manage information regarding the virtual classroom.
Requirement Right to evaluation: If the attendance percentage is less than 80% the
description: student does not have the right to evaluation in the unit. The system will
notify this situation for each unit.
Non-functional
requirement: • RNF01
• RNF02
• RNF05
• RNF06
•
Priority of the requirement: RNF07
High

Requirement RF09
Identification:

Software Requirements Description

 Software Requirements Specification P. 11

Name of the Allow assigning value to weights per unit, per group

Software Requirements Description

 Software Requirements Specification P. 12

Request:
Characteristics:
Allows you to manage information about student grades by unit.
Requirement Consult courses: allows the teacher to place the grades per unit in each
description: group.
Non-functional
requirement: • RNF01
• RNF02
• RNF05
• RNF06
•
Priority of the requirement: RNF07
High

Requirement RF010
Identification:
Name of the Allow the link between attendance percentage and its weighting (dropouts)
Request: in the final report
Characteristics: Allows you to manage information about absences
Requirement Dropouts: Allows the teacher to view the students who dropped out at the
description: end of the course. This amount will be displayed in the final report.
Non-functional
requirement: • RNF01
• RNF02
• RNF05
• RNF06
•
Priority of the requirement: RNF07
High

Requirement RF11
Identification:
Name of the Generation of partial grade reports (per unit)
Request:
Characteristics: The system will allow reports to be generated.
Requirement Partial report: Generation of a report displaying the numbers and
description: percentages of students who pass and do not pass the unit. The teacher
may select more than one unit.
Non-functional
requirement: • RNF01
• RNF02
• RNF05

Software Requirements Description

 Software Requirements Specification P. 13

• RNF07
•
Priority of the requirement: RNF08
High

Requirement RF12
Identification:
Name of the Generation of final grade reports
Request:
Characteristics: The system will allow reports to be generated.
Requirement Final report: Generation of a report displaying the numbers and
description: percentages of students who pass and do not pass each unit in all
subjects. It is also included if the student accredited the unit on a second
occasion.
Non-functional
requirement: • RNF01
• RNF02
Generation of partial grade reports (per unit)
Priority of the requirement:
High

Requirement RF13
Identification:
Name of the Assign grade on second chance
Request:
Characteristics: The system will allow students to be graded.
Requirement The system will allow for the assignment of a grade on a second occasion
description: (complementary period).
Non-functional
requirement: •RNF01
•
Priority of the requirement: RNF02
High

Requirement RF14
Identification:
Name of the Upload portfolio of evidence for each unit (pdf or Word file).
Request:
Characteristics: Upload file to system by unit
Requirement Allows the teacher to attach 3 files per unit as a portfolio of evidence,
description: obtained from the students
Non-functional
requirement: • RNF01
•
Priority of the requirement: RNF02
High

Requirement RF15
Identification:
Name of the System audit
Request:
Characteristics:
Ensure solutions to existing problems through the use of the system.
Requirement Evaluate and analyze system processes, proposing solutions to existing
description: problems within the system used.
Non-functional
requirement: • RNF03
• RNF04
Software Requirements Description
 Software Requirements Specification P. 14

• RNF06
• RNF07
Priority of the requirement: • RNF08
High

Non-functional requirements.

Requirement RNF01
Identification:
Name of the System interface.
Request:
Characteristics: The system will present a simple user interface to make it easy for system
users to use.
Requirement The system must have an intuitive and simple user interface.
description:
Priority of the requirement:
High

Requirement RNF02
Identification:
Name of the Help in using the system.
Request:
Characteristics:
The user interface must present a help system so that the users of the
system can make their work easier in terms of system management.
Requirement The interface must be complemented by a good help system
description: (administration may be carried out by staff with little experience in the use
of computer applications).
Priority of the requirement:
High

Requirement RNF03
Identification:
Name of the Maintenance.
Request:
Characteristics:
The system must have an installation manual and a user manual to
facilitate maintenance that will be performed by the administrator.
Requirement
description: The system must have easily updatable documentation that allows
maintenance operations to be carried out with the least possible effort.
Priority of the requirement:
High

Requirement RNF04
Identification:

Software Requirements Description

 Software Requirements Specification P. 15

Name of the Interface design for web and mobile application features
Request:
Characteristics: The system must have a user interface, taking into account the
characteristics of the institution's website. It must also allow the use of the
system through a mobile application.
Requirement The user interface must be adapted to the characteristics of the institution's
description: website, within which the process management system and inventory will
be incorporated.
Requirement Priority: High

Requirement RNF05
Identification:
Name of the Performance
Request:
Characteristics:
The system will guarantee users performance in terms of data stored in the
system, offering it reliability.
Requirement Ensure the performance of the computer system to the different users. In
description: this sense, the stored information or records made may be consulted and
updated permanently and simultaneously, without affecting the response
time.
Priority of the requirement:
High

Requirement RNF06
Identification:
Name of the User Level
Request:
Characteristics: It will guarantee the user access to information according to the level they
possess.
Requirement Facilities and controls to allow access to information to authorized
description: personnel via the Internet, with the intention of consulting and uploading
information relevant to each of them.
Priority of the requirement:
High

Requirement RNF07
Identification:
Name of the Continued system reliability.
Request:
Characteristics: The system will have to be operational 24 hours a day, 7 days a week.
Since it is a website designed for data loading and communication between
users.
Requirement The system must be continuously available with a service level for users 7
description: days a week, 24 hours a day, ensuring an adequate scheme that allows for
possible failure in any of its components, having a contingency, and
generating alarms.
Priority of the requirement:
High

Requirement RNF08
Identification:
Name of the Information security
Request:

Software Requirements Description

 Software Requirements Specification P. 16

Characteristics: The system will guarantee users security regarding the information that is
processed in the system.
Requirement Ensure system security with respect to the information and data handled,
description: such as documents, files and passwords.
Requirement Priority: High

3.1 Common interface requirements

3.1.1 User interfaces

The user interface will consist of a set of windows with buttons, lists and text fields.
This must be built specifically for the proposed system and will be viewed from an
internet browser and mobile application.

3.1.2 Hardware interfaces

It will be necessary to have computer equipment in perfect condition with the

following characteristics:

• Network adapters.
• Processor of1.66GHzeithersuperior.
• Memoryminimum of256Mb.
• Mouse.
• Keyboard.
In the case of use with a mobile device, you have:
• Mobile device with Android operating system, minimum version 5.1
• 1.33 GHz or higher processor.
• Minimum memory of 512 Mb.

3.1.3 Software interfaces

• Operating System: Windows XP or higher.

• Browser: Mozilla or Chrome.
• Mobile operating system Android 5.1 or higher

3.1.4 Communication interfaces

Servers, clients and applications will communicate with each other using standard
Internet protocols whenever possible. For example, to transfer files or documents,
existing protocols (FTP or other convenient ones) should be used.

3.2 Functional requirements

3.2.1 Functional requirement 1
• User Authentication: users must identify themselves to access any part of the
system.

Software Requirements Description

 Software Requirements Specification P. 17

✓ The system can be consulted by any user depending on the module

they are in and their level of accessibility.

3.2.2 Functional requirement 2

• Consult Information: The system will offer the user general information
about Academic Instruction, subjects, and Calendar of Events.

✓ Consult Academic Instruction: Shows general information about

the courses that the institution offers, what they consist of, and
duration per academic period.
✓ Consult Subjects: Allows students to see the
assignments that teachers have posted, download guides and
information relevant to the subject, and view grades obtained in
evaluations.
✓ Check Events Calendar: Show users information relevant to news
or other planned events.

3.2.3 Functional requirement 3

• Register Users: The system will allow the user (student, teacher and
Administrator) to register. The user must provide data such as: ID, Name,
Surname, Email, Username and Password.

3.2.4 Functional requirement 4

• Modify: Allows the administrator to modify data of users, subjects and

created accounts.

3.2.5 Functional requirement 5

•classroom.
Manage Virtual Classroom: Allows information regarding the virtual

✓ Create Courses: Allows the teacher, once they have accessed the
virtual classroom with their account, to create their subject and provide
relevant information to the students, maintaining active communication.

✓ Register Student: The student must provide his/her identity card

and name along with a password in order to enroll in a subject.

o Virtual Classroom: The student must register by entering

a username along with a password to enter the system.

o Subject: The student must enter the password

provided by the teacher to be enrolled in the subject.

✓ View courses: Allows students to view information on pending

activities and completed assessment grades.

Software Requirements Description

 Software Requirements Specification P. 18

✓ Downloads: Allows students to download guides and information

relevant to the subjects they are taking only if they are enrolled in them.

✓ Forums: Students will be able to hold a discussion and view

information on a topic determined by the teacher.

o Allows user interaction and discussion on topics previously

raised.

o Raising issues regarding a task or problem to be developed.

o Allows you to upload files and documents linked to a link to

download and to have better communication and interaction
between users

o Users who participate in the forum must have previously

registered in the subject

3.2.6 Functional requirement 6

• Component Integration: The inventory component together with Moodle must
be integrated into the web information system, providing the necessary
resources, so that interaction with users is beneficial in the management of
academic information.

3.2.7 Functional requirement 7

• Manage Reports: Allows the administrator to print reports of events to be

held or completed, as well as view lists of students by subject, active teachers,
among others.

3.2.8 Functional requirement 8

• Accredit: Allows the administrator and teacher to certify that the student
participated and completed the course or event in which he or she was
enrolled.

3.2.9 Functional requirement 9

• Audit: Evaluate and analyze the system processes, proposing solutions to

existing problems within the system used

3.3 Non-functional requirements

3.3.1 Performance Requirements
• Ensure that query design or other processing does not impact database
performance or significantly impact network traffic.

3.3.2 Security

• Guarantee the reliability, security and performance of the computer system to

the different users. In this sense, the stored information or records made may
be consulted and updated permanently and simultaneously, without affecting
the response time.

Software Requirements Description

 Software Requirements Specification P. 19

• Ensure system security with respect to the information and data handled, such
as documents, files and passwords.

• Facilities and controls to allow access to information to authorized personnel

via the Internet, with the intention of consulting and uploading information
relevant to each of them.

3.3.3 Reliability

• The system must have an intuitive and simple user interface.

• The user interface must be adapted to the characteristics of the institution's

website, within which the process management system and inventory will be
incorporated.

3.3.4 Availability

• The system availability must be continuous with a service level for users of 7
days for 24 hours, guaranteeing an adequate scheme that allows for the
possible failure of any of its components, having a contingency, and
generating alarms.

3.3.5 Maintainability

• The system must have easily updatable documentation that allows

maintenance operations to be carried out with the least possible effort.

• The interface must be complemented by a good help system (administration

may be carried out by staff with little experience in the use of computer
applications).

3.3.6 Portability

• The system will be implemented under the Windows platform.

Software Requirements Description