You are on page 1of 19

Meerut Institute of Engineering & Technology Project

Name
Software Requirements Specification

WEB PUBLISHING SYSTEM

SOFTWARE REQUIREMEMENTS SPECIFICATION (SRS)

Prepared By
Name 1
Name 2
Name 3
Year
Guide

MEERUT INSTITUTE OF ENGINEERING & TECHNOLOGY, MEERUT


Affiliated to
Dr. APJ ABDUL KALAM UNIVERSITY

Version 0.2 (DRAFT)

1
Meerut Institute of Engineering & Technology Project
Name
Software Requirements Specification

© MEERUT INSTITUTE OF ENGINEERING & TECHNOLOGY, MEERUT


All rights reserved. No part of this publication may be reprinted, reproduced,
stored in a retrieval system or transmitted, in any form or by any means,
without the prior permission in writing from the owners.

2
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

Status Draft
Client Deliverable Yes
Item
Configuration Item Yes
Distribution 1. -----------------------
2. ----------------------

Revision History
Version Date Change Description Author
0.1 __October, 2021 Created Dr. Tanveer
0.2 __November,2021

3
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

INTERNAL USE ONLY:

Contributors:
Prof.Tanveer Ikram Subject Expert
Mr. XYZ Subject Expert

Created By: Reviewed By Project Guide:


Name 1
Name 2
Name 3
_____________________________ _____________________________
Name: Name:
Designation: Designation:
Department: Department:
Date: Date:

Reviewed By Project Head: Approved By HOD:

_____________________________ _____________________________
Name: Name:
Designation: Designation:
Department: Department:
Date: Date:

4
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

Contents

1 INTRODUCTION...............................................................................................1-6
1.1 PROBLEM STATEMENT...................................................................................1-6
1.2 WHY IS THE PARTICULAR TOPIC CHOSEN?......................................................1-6
1.3 PURPOSE OF SYSTEM REQUIREMENTS SPECIFICATION (SRS).........................1-6
1.4 SCOPE.......................................................................................................... 1-6
1.5 DEFINITIONS, ACRONYMS, AND ABBREVIATIONS..............................................1-7
1.6 REFERENCES.................................................................................................1-8
1.7 DOCUMENT OVERVIEW...................................................................................1-9
2 Overall Description...........................................................................................10
3 Specific Requirements.....................................................................................12
3.1 FUNCTIONALITY...............................................................................................12
3.1.1 <Functional Requirement One>...................................................................12
3.1.2 LOGIN..........................................................................................................12
3.1.3 Use Case 2...................................................................................................15
3.1.4 Use Case 4...................................................................................................15
3.1.5 Use Case 5...................................................................................................15
3.2 USER CHARACTERSTICS................................................................................. 15
3.3 NON FUNCTIONAL REQUIREMENTS..................................................................16
3.3.1 Reliability......................................................................................................16
3.3.2 Performance.................................................................................................17
3.3.3 Supportability................................................................................................17
3.3.4 Design Constraints.......................................................................................17
3.3.5 Security.........................................................................................................17
3.4 ON-LINE USER DOCUMENTATION AND HELP SYSTEM REQUIREMENTS...............18
3.5 PURCHASED COMPONENTS.............................................................................18
3.6 INTERFACES....................................................................................................18
3.7 INTERFACES REQUIREMENTS...........................................................................18
3.7.1 Hardware Interfaces.....................................................................................18
3.7.2 Software Interfaces......................................................................................18
3.8 LICENSING REQUIREMENTS.............................................................................19
3.9 LEGAL, COPYRIGHT, AND OTHER NOTICES......................................................19
3.10 APPLICABLE STANDARDS................................................................................19
4 Supporting Information.......................................................................................19

5
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

1 INTRODUCTION
1.1 Purpose of System Requirements Specification (SRS)

[The introduction of the  Software Requirements Specification (SRS)  should provide an


overview of the entire SRS. It should include the purpose, scope, definitions, acronyms,
abbreviations, references, and overview of the SRS.]

[Note: The Software Requirements Specification (SRS) captures the complete software
requirements for the system, or a portion of the system.  Following is a typical SRS outline
for a project using only traditional natural-language style requirements – with no use-case
modeling.   It captures all requirements in a single document,  with  applicable sections
inserted from the  Supplementary Specifications (which would no longer be needed).  For a
template of an  SRS  using use-case modeling, which consists of a package containing Use-
Cases of the use-case model and applicable Supplementary Specifications and other
supporting information, see rup_SRS-uc.dot.]

[Many different arrangements of an  SRS  are possible.  Refer to [IEEE830-1998] for further
elaboration of these explanations, as well as other options for SRS organization.]

The purpose of this document is to present a detailed description of the Web

Publishing System. It will explain the purpose and features of the system,

the interfaces of the system, what the system will do, the constraints under

which it must operate and how the system will react to external stimuli. This

document is intended for both the stakeholders and the developers of the

system and will be proposed to the Regional Historical Society for its

approval.

1.2 Scope

[Specify the purpose of this SRS. The  SRS  should fully describe the external behavior of the
application or subsystem identified. It also describes nonfunctional requirements, design
constraints and other factors necessary to provide a complete and comprehensive description
of the requirements for the software.]

This software system will be a Web Publishing System for a local

editor of a regional historical society. This system will be designed to

maximize the editor’s productivity by providing tools to assist in automating

6
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

the article review and publishing process, which would otherwise have to be

performed manually. By maximizing the editor’s work efficiency and

production the system will meet the editor’s needs while remaining easy to

understand and use.

More specifically, this system is designed to allow an editor to

manage and communicate with a group of reviewers and authors to publish

articles to a public website. The software will facilitate communication

between authors, reviewers, and the editor via E-Mail. Preformatted reply

forms are used in every stage of the articles’ progress through the system to

provide a uniform review process; the location of these forms is configurable

via the application’s maintenance options. The system also contains a

relational database containing a list of Authors, Reviewers, and Articles.

1.3 Definitions, Acronyms, and Abbreviations

[This subsection should provide the definitions of all terms, acronyms, and abbreviations
required to properly interpret the  SRS.  This information may be provided by
reference to the project Glossary.]

Term Definition
Active Article The document that is tracked by the system; it is a
narrative that is planned to be posted to the public
website.

Author Person submitting an article to be reviewed. In case of


multiple authors, this term refers to the principal author,
with whom all communication is made.

Collection of all the information monitored by this


Database
system.

Editor Person who receives articles, sends articles for review,


and makes final judgments for publications.

Field A cell within a form.

7
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

Historical Society
The existing membership database (also HS database).
Database

Member A member of the Historical Society listed in the HS


database.

Reader Anyone visiting the site to read articles.

Review A written recommendation about the appropriateness of


an article for publication; may include suggestions for
improvement.

Reviewer A person that examines an article and has the ability to


recommend approval of the article for publication or to
request that changes be made in the article.

Software A document that completely describes all of the


Requirements functions of a proposed system and the constraints
Specification under which it must operate. For example, this
document.

Stakeholder Any person with an interest in the project who is not a


developer.

User Reviewer or Author.

1.4 References

[This subsection should provide a complete list of all documents referenced elsewhere in
the SRS.  Each document should be identified by title, report number (if applicable), date,
and publishing organization.  Specify the sources from which the references can be
obtained. This information may be provided by reference to an appendix or to another
document.]

The following documents were referenced in developing this Software


Requirements Specification document:

1. IEEE. IEEE Std 830-1998 IEEE Recommended Practice for Software


Requirements Specifications. IEEE Computer Society, 1998.
2. “Agreement for MATRIIX Project-Phase I”, January 2021, Appendix A on
Statement of Work.

3. “Rational Unified Process Fundamentals”, March 2002. Rational Software


Corporation, CA, USA.

4. MIDA website – http://www.mida.gov.my

1.5 Document Overview

[This subsection should describe what the rest of the SRS contains and explain how the
document is organized.]

8
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

This Software Requirement Specifications (SRS) is based on IBM RUP


standard template. The document is organized in the following structure:

Chapter 1 – Introduction - This section describes the overview of SRS, the


scope covered and the acronyms used throughout this document.

Chapter 2 – Overall Description - This section describes high-level


requirements that provide a mechanism for users to describe their expectations
of the system.

Chapter 3 – Specific Requirements – This section describes identifies the


functional and non-functional requirements of the system.

Chapter 4 – Supporting Information - This section describes all supporting


information that makes SRS easy to use.

End of Section

9
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

2 OVERALL DESCRIPTION
[This section of the  SRS  should describe the general factors that affect the product and its
requirements.  This section does not state specific requirements.  Instead, it provides a
background for those requirements, which are defined in detail in Section 3, and makes them
easier to understand. Include such items as:

•                     product perspective

•                     product functions

•                  user characteristics

•                     constraints

•                     assumptions and dependencies

•                     requirements subsets]

10
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

Figure 1 - System Environment

The Web Publishing System has four active actors and one

cooperating system.

The Author, Reader, or Reviewer accesses the Online Journal through the

Internet. Any Author or Reviewer communication with the system is through

email. The Editor accesses the entire system directly. There is a link to the

(existing) Historical Society.

<< The division of the Web Publishing System into two component parts, the

Online Journal and the Article Manager, is an example of using domain

classes to make an explanation clearer. >>

11
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

3 SPECIFIC REQUIREMENTS

[This section of the  SRS  should contain all the software requirements to a level of detail
sufficient to enable designers to design a system to satisfy those requirements, and testers
to test that the system satisfies those requirements.   When using use-case modeling, these
requirements are captured in the Use-Cases and the applicable supplementary
specifications.  If use-case modeling is not used, the outline for supplementary specifications
may be inserted directly into this section, as shown below.]
3.1 Functionality

[This section describes the functional requirements of the system for those requirements
which are expressed in the natural language style. For many applications, this may constitute
the bulk of the SRS Package and thought should be given to the organization of this section.
This section is typically organized by feature, but alternative organization methods may also
be appropriate, for example, organization by user or organization by subsystem.  Functional
requirements may include feature sets, capabilities, and security.

Where application development tools, such as requirements tools, modeling tools, etc., are
employed to capture the functionality, this section document will refer to the availability of
that data, indicating the location and name of the tool that is used to capture the data.]
3.1.1 <Functional Requirement One>

[The requirement description.]


This section outlines the use cases for each of the active readers separately.

The reader, the author and the reviewer have only one use case apiece

while the editor is main actor in this system.

3.1.2 LOGIN
Brief Description

This use case describes process by which Actor can enter into system using

his/her ActorID and password.

Actor

Admin, Customer

Flow of Events

Basic Flow

12
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

BF- Successfull LOGIN for Admin

1.Use case starts when Actor browse application

2.System will prompt Actor to enter ActorID and password to login

3.Actor enters ActorID and password.

4.Actor submits.

5.System checks ActorID and password correct.

6.System will display welcome admin.

7.The use case ends.

Alternative Flows

AF1- Successfully LOGIN for Customer

1.Use case starts when Actor browse application

2.System will prompt Actor to enter ActorID and password to login

3.Actor enters ActorID and password.

4.Actor submits.

5.System checks ActorID and password.

6.System will display welcome Customer.

7.The use case ends.

AF2- Unsuccessfull LOGIN

1. Use case starts when Actor browse application

2. System will prompt Actor to enter Actor ID and password to login

3. System checks ActorID and password.

13
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

4. System will display message Actor Id or password does not exists or

incorrect.

5. The use case ends.

Exceptional Flow

EF1- Actor must enter UserID (min 6-15 characters), password (min 6-15

characters

EF2- No special characters in UserID and password

Pre-conditions

None

Post-conditions

None

Include Use Cases

None

Extend Use Cases

None

Comments

None

14
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

Screen

3.1.3 Use Case 2

3.1.4 Use Case 4

3.1.5 Use Case 5

3.2 User Characterstics

[This section should include all of those requirements that affect usability. For example,

•                     specify the required training time for a normal users and a power user to
become productive at particular operations

•                     specify measurable task times for typical tasks or base the new system’s
usability requirements on other systems that the users know and like

•                     specify requirement to conform to common usability standards, such as IBM’s


CUA standards Microsoft’s GUI standards]
The Reader is expected to be Internet literate and be able to use a

search engine. The main screen of the Online Journal Website will have the

search function and a link to “Author/Reviewer Information.”

15
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

The Author and Reviewer are expected to be Internet literate and to be

able to use email with attachments.

The Editor is expected to be Windows literate and to be able to use

button, pull-down menus, and similar tools.

The detailed look of these pages is discussed in section 3.2 below.

3.3 Non Functional Requirements

The Online Journal will be on a server with high speed Internet capability.

The physical machine to be used will be determined by the Historical

Society. The software developed here assumes the use of a tool such as

Tomcat for connection between the Web pages and the database. The

speed of the Reader’s connection will depend on the hardware used rather

than characteristics of this system.

The Article Manager will run on the editor’s PC and will contain an

Access database. Access is already installed on this computer and is a

Windows operating system.

3.3.1 Reliability

[Requirements for reliability of the system should be specified here. Some suggestions
follow:

•                     Availability—specify the percentage of time available ( xx.xx%), hours of use,


maintenance access, degraded mode operations, etc.

•                     Mean Time Between Failures (MTBF) — this is usually specified in hours, but it
could also be specified in terms of days, months or years.

•                     Mean Time To Repair (MTTR)—how long is the system allowed to be out of
operation after it has failed?

•                     Accuracy—specify precision (resolution) and accuracy (by some known


standard) that is required in the system’s output.

16
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

•                     Maximum Bugs or Defect Rate—usually expressed in terms of bugs per


thousand of lines of code (bugs/KLOC) or bugs per function-point( bugs/function-point).

•                     Bugs or Defect Rate—categorized in terms of minor, significant, and critical


bugs: the requirement(s) must define what is meant by a “critical” bug; for example, complete
loss of data or a complete inability to use certain parts of the system’s functionality.]
3.3.2 Performance

[The system’s performance characteristics should be outlined in this section. Include specific
response times. Where applicable, reference related Use Cases by name.

•                rresponse time for a transaction (average, maximum)

•                throughput, for example, transactions per second

•               capacity, for example, the number of customers or transactions the system can
accommodate

•                  degradation modes (what is the acceptable mode of operation when the system
has been degraded in some manner)

•                  resource utilization, such as memory, disk, communications, etc.

3.3.3 Supportability

[This section indicates any requirements that will enhance the supportability or maintainability
of the system being built, including coding standards, naming conventions, class libraries,
maintenance access, maintenance utilities.]
3.3.4 Design Constraints

[This section should indicate any design constraints on the system being built. Design
constraints represent design decisions that have been mandated and must be adhered to. 
Examples include software languages, software process requirements, prescribed use of
developmental tools, architectural and design constraints, purchased components, class
libraries, etc.]
3.3.5 Security
The server on which the Online Journal resides will have its own security to

prevent unauthorized write/delete access. There is no restriction on read

access. The use of email by an Author or Reviewer is on the client systems

and thus is external to the system.

The PC on which the Article Manager resides will have its own security. Only

the Editor will have physical access to the machine and the program on it.

17
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

There is no special protection built into this system other than to provide the

editor with write access to the Online Journal to publish an article.


3.4 On-line User Documentation and Help System Requirements

[Describes the requirements, if any, for on-line user documentation, help systems, help about
notices, etc.]
3.5 Purchased Components

[This section describes any purchased components to be used with the system, any
applicable licensing or usage restrictions, and any associated compatibility and
interoperability or interface standards.]
3.6 Interfaces

[This section defines the interfaces that must be supported by the application. It should
contain adequate specificity, protocols, ports and logical addresses, etc. so that the software
can be developed and verified against the interface requirements.]
3.7   Interfaces Requirements

[This section defines the interfaces that must be supported by the application. It should
contain adequate specificity, protocols, ports and logical addresses, etc. so that the software
can be developed and verified against the interface requirements.]

[Describe the user interfaces that are to be implemented by the software.]


3.7.1   Hardware Interfaces

[This section defines any hardware interfaces that are to be supported by the software,
including logical structure, physical addresses, expected behavior, etc. ]
3.7.2   Software Interfaces

[This section describes software interfaces to other components of the software system.
These may be purchased components, components reused from another application or
components being developed for subsystems outside of the scope of this  SRS  but with
which this software application must interact.]
The only link to an external system is the link to the Historical Society (HS)

Database to verify the membership of a Reviewer. The Editor believes that a

society member is much more likely to be an effective reviewer and has

imposed a membership requirement for a Reviewer. The HS Database fields

of interest to the Web Publishing Systems are member’s name, membership

(ID) number, and email address (an optional field for the HS Database).

18
Meerut Institute of Engineering & Technology Project Name
Software Requirements Specification

The Assign Reviewer use case sends the Reviewer ID to the HS Database

and a Boolean is returned denoting membership status. The Update

Reviewer use case requests a list of member names, membership numbers

and (optional) email addresses when adding a new Reviewer. It returns a

Boolean for membership status when updating a Reviewer.

3.8 Licensing Requirements

[Defines any licensing enforcement requirements or other usage restriction requirements that
are to be exhibited by the software.]
3.9  Legal, Copyright, and Other Notices

[This section describes any necessary legal disclaimers, warranties, copyright notices, patent
notice, wordmark, trademark, or logo compliance issues for the software.]
3.10  Applicable Standards

[This section describes by reference any applicable standard and the specific sections of any
such standards which apply to the system being described. For example, this could include
legal, quality and regulatory standards, industry standards for usability, interoperability,
internationalization, operating system compliance, etc.]

4   SUPPORTING INFORMATION

[The supporting information makes the SRS easier to use.  It includes:

•                Table of contents

•                 Index

•                Appendices

These may include use-case storyboards or user-interface prototypes. When appendices are
included, the SRS should explicitly state whether or not the appendices are to be considered
part of the requirements.]

End of Section

h t t p s : / / d o c s . h u i h o o . c o m / d e v e l o p m e n t /
r u p / r u p c m m . h t m

Reaching CMM Levels 2 and 3 with the Rational Unified Process

19

You might also like