SRS Template - v0.4

Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 20

System Requirement Specification

<Name of System>

Security Classification: Confidential


Approval Page

Decision Approved Rejected

Name:

Signature/Date:

1
Revision History
Date Version Author Change Description

DD/MM/YYYY 0.1.0 Author First Creation

2
Table of Contents
1. Introduction........................................................................................................................................... 4

1.1 Purpose..................................................................................................................................................... 4

1.2 Glossary and Abbreviations....................................................................................................................... 5

1.3 Document Referenced............................................................................................................................... 6

2. High Level Requirements..................................................................................................................... 7

2.1 High Level Business Process (SWIMLANE DIAGRAM)............................................................................7

2.2 Entity Relationship Diagram...................................................................................................................... 8

2.3 Use Case Diagram.................................................................................................................................... 9

2.4 Actor.......................................................................................................................................................... 0

2.5 Use Case Catalogue................................................................................................................................. 0

2.6 Site Map (Optional).................................................................................................................................... 0

3. Use Case Specifications....................................................................................................................... 1

3.1 UC01 <Name of Use Case>...................................................................................................................... 1

3.1.1 Overview................................................................................................................................................ 1

3.1.2 Activity Flow (Optional).......................................................................................................................... 1

3.1.3 Flow of Events....................................................................................................................................... 1

3.1.4 Mock-up Screen.................................................................................................................................... 2

3.1.5 Screen Description................................................................................................................................ 2

3.1.6 Business Rules...................................................................................................................................... 2

3.2 UC2: Approve/Reject Approval Request................................................................................................... 2

3.2.1 Overview................................................................................................................................................ 2

3.2.2 Flow of Events....................................................................................................................................... 3

3.2.3 Mock-up Screen.................................................................................................................................... 5

3.2.4 Screen Description................................................................................................................................ 5

3.2.5 Business Rules...................................................................................................................................... 7

4. Appendices........................................................................................................................................... 8

4.1 Message List............................................................................................................................................. 8

4.2 Email List................................................................................................................................................... 8

3
4
1. INTRODUCTION
1.1 Purpose
The Software Requirement Specifications will:
 Define the scope of business objectives, business functions, and organizational units covered,
 Identify the business processes that the solution must facilitate,
 Facilitate a common understanding of what the functional requirements are for all parties involved,
 Establish a basis for defining the acceptance tests for the solution to confirm that what is delivered meets
requirements.
The purpose of the document is to collect and analyse 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.

5
1.2 Glossary and Abbreviations
Acronym Reference

SRS System Requirement Specification

UC Use Case

BR Business Rules

CBR Common Business Rules

ET Email Template

N/A Not Applicable or Not Available

MSG Message

[Field] Convention for mentioning a field

<<Field>> Convention for value of this field, specifically use in the context of Email Template

“Text Value” Convention for mentioning a value

<Value> Convention for mentioning special value, i.e. <Today>, <Current User>

TBU To be Updated

NRF National Research Foundation

OOE Other Operating Expenditure

N/A Not Available

6
1.3 Document Referenced
Attachment Document Name / Title

High Level Requirement Slide

High Level Wireframes

7
2. HIGH LEVEL REQUIREMENTS
This section describes the general overview of the system functions or business processes which are depicted in
different diagrams. It shows the types of users, their granted permissions to perform specific system functions and
the sequence required to complete a business workflow (if any). As the section name implies, it is high-level which
means not detailed enough. For detailed requirement specification, please see Error: Reference source not
found section below.

2.1 High Level Business Process


<Flowchart>
<Swim-lane diagram>

8
2.2 Entity Relationship Diagram

9
2.3 Use Case Diagram

10
2.4 Actor
Actors Description

Students

Teachers

Managers

Administrators

2.5 Use Case Catalogue


UC ID UC Name Description

UC01 XXXXXXX This Use Case allows user to XXXXXXXXXX.

UC02 XXXXXXX This Use Case allows users to XXXXXXXXX.

2.6 Site Map


<The site map describes the way for navigating through the system. (Optional)>

11
3. USE CASE SPECIFICATIONS
This section covers the system’s functional requirements which details what the system must do in terms of input,
behavior and the expected output. It elicits the interaction between the actor(s) and the system, the system’s
behavior and the results of their interactions.

3.1 UC01 <Name of Use Case>


3.1.1 Overview.
ID and Name

Description

Actor

Trigger

Pre-condition

Post-condition

3.1.2 Activity Flow


<This is optional>

3.1.3 Flow of Events


3.1.3.1 Basic Flow

Step Description

1.

2.

3.

4.

5.

3.1.3.2 Alternative Flow - <Name of flow>

Step Description

1.

2.

3.

12
3.1.3.3 Alternative Flow - <Name of flow>

Step Description

1.

2.

3.1.3.4 Exceptional Flow - <Name of flow>

Step Description

1.

2.

3.1.4 Mock-up Screen


<Insert Screens>

3.1.5 Screen Description

Field Control Data Default


REF Mandatory Editable Description
Name Type Type Value

3.1.6 Business Rules


Business Rule ID Business Rule Description

BRL-01-01

BRL-01-02

BRL-01-03

3.2 UC2: Approve/Reject Approval Request


3.2.1 Overview
ID and Name

Description This use case allows user to view the list of all members of all companies.

13
Actor All authenticated users

Trigger User selects to view the list of members from the left menu.

Pre-condition User who has been granted with the corresponding permission.

Post-condition List of members is displayed successfully.

3.2.2 Activity Flow


<This is optional>

3.2.3 Flow of Events


3.2.3.1 Basic Flow

Step Description

1. The system displays a list of XXXXXXXXXXXXX that have not been reviewed

2. The user selects a case.

3. The system validates that the case is XXXXXXXXXXXXX

4. The system determines the XXXXXXXXXXXXX

5. The system marks the case as XXXXXXXXXXXXX

6. The system records the XXXXXXXXXXXXX

7. The system records the XXXXXXXXXXXXX

8. The system records the fact that the case has been reviewed

3.2.3.2 Alternative Flow - Non-payable case

Continued from step #3 in the Basic Flow:

Step Description

1. The system marks the case as XXXXXXXXXXXXX

2. The system marks the case as XXXXXXXXXXXXX

3. Continue at Step 8 in the Basic Flow

3.2.3.3 Alternative Flow - Cash funds low but sufficient

Continued from step #7 in the Basic Flow:

Step Description

1. XXXXXXXXXXXXX low but sufficient

2. The system displays the XXXXXXXXXXXXX warning. (See “Prompts and Messages.”)

14
3.2.3.4 Exceptional Flow - <Name of flow>

Step Description

1.

2.

15
3.2.4 Mock-up Screen

3.2.5 Screen Description


Dat
Defaul
RE Field Control a Mandator Editabl
t Description
F Name Type Typ y e
Value
e

1 New Button N/A N/A N/A N/A  Allow user to create


Employe XXXXXXXXXXXXXXXXXXX.
e  Trigger UC
“XXXXXXXXXXXX”, please
refer to the document
“<TBD>” for more details.

2 Re-join Button N/A N/A N/A N/A  Allow user to create


XXXXXXXXXXXXX.
 Trigger UC “Re-join
Employee”, please refer to
the document “<TBD>” for
more details.
 Disable if there is
XXXXXXXXXXXXX.
Disable this button if the
XXXXXXXXXXXXX

3 Terminat Button N/A N/A N/A N/A  Allow user to terminate


e selected employees
 Trigger UC “Terminate
Employee”, please refer to
the document “<TBD>” for
more details.
 Disable if there is
XXXXXXXXXXXXX.
Disable this button if
XXXXXXXXXXXXX

4 Refresh Button N/A N/A Refresh the screen and reload

16
Dat
Defaul
RE Field Control a Mandator Editabl
t Description
F Name Type Typ y e
Value
e

the data.

5 Member Other N/A All N/A N/A  This field allow user to
View Active XXXXXXXXX.
Member  Value list:
 All Member: When user
selects this view, list out all
XXXXXXX regardless of
their Status.
 All Active
Member:XXXXXXXXXXXX
X.
 All Terminated Member:
XXXXXXXXXXXXX.
 All Active Employee:
XXXXXXXXXXXXX.

6 Compan Dropdow N/A All N/A N/A  This is a search criteria which
y n List allows user to search for
XXXXXXXXXXXXX.
 Value list:
 All
 List all active companies
XXXXXXXXXXXXX.
Sort ascending by Company
Name.

7 Member Search N/A N/A N/A N/A This is a XXXXXXXXXXXXX


Search box

8 Search Button N/A N/A N/A N/A  Allows user to search for
members using inputted
search criteria.
Trigger UC XXXXXXXXXXXXX

17
3.2.6 Business Rules
Business Rule ID Business Rule Description

BRL-02-01 Age of children must be => 8 or <= 25 years old

BRL-02-02 The combination of Full Name and NRIC must be unique within the entire system

18
4. APPENDICES
4.1 Message List

4.2 Email List

19

You might also like