Srs
Srs
Srs
Items that are intended to stay in as part of your document are in bold; explana
tory comments are in italic text. Plain text is used where you might insert wor
ding about your project.
The document in this file is an annotated outline for specifying software requir
ements, adapted from the IEEE Guide to Software Requirements Specifications (Std
830-1993).
Tailor this to your needs, removing explanatory comments as you go along. Where
you decide to omit a section, you might keep the header, but insert a comment s
aying why you omit the data.
CS3911
(Team Number)
(Team Name)
Table of Contents
1. Introduction 5
1.1 Purpose 5
1.2 Scope 5
1.3 Definitions, Acronyms, and Abbreviations 5
1.4 References 5
1.5 Overview
5
2. The Overall Description 6
2.1 Product Perspective 6
2.1.1 System Interfaces 6
2.1.2 Interfaces 6
2.1.3 Hardware Interfaces 6
2.1.4 Software Interfaces 7
2.1.5 Communications Interfaces 7
2.1.6 Memory Constraints 7
2.1.7 Operations 7
2.1.8 Site Adaptation Requirements 7
2.2 Product Functions 8
2.3 User Characteristics 8
2.4 Constraints 8
2.5 Assumptions and Dependencies 9
2.6 Apportioning of Requirements
9
3. Specific Requirements 9
3.1 External interfaces 10
3.2 Functions 10
3.3 Performance Requirements 11
3.4 Logical Database Requirements 11
3.5 Design Constraints 12
3.5.1 Standards Compliance 12
3.6 Software System Attributes 12
3.6.1 Reliability 12
3.6.2 Availability 12
3.6.3 Security 12
3.6.4 Maintainability 13
3.6.5 Portability 13
3.7 Organizing the Specific Requirements 14
3.7.1 System Mode 14
3.7.2 User Class 14
3.7.3 Objects 14
3.7.4 Feature 14
3.7.5 Stimulus 15
3.7.6 Response 15
3.7.7 Functional Hierarchy 15
3.8 Additional Comments
15
4. Change Management Process
5. Document Approvals
6. Supporting Information 15
1. Introduction
The following subsections of the Software Requirements Specifications (SRS) docu
ment should provide an overview of the entire SRS. The thing to keep in mind a
s you write this document is that you are telling what the system must do – so tha
t designers can ultimately build it. Do not use this document for design!!!
1.1 Purpose
Identify the purpose of this SRS and its intended audience. In this subsection,
describe the purpose of the particular SRS and specify the intended audience for
the SRS.
1.2 Scope
In this subsection:
(1) Identify the software product(s) to be produced by name
(2) Explain what the software product(s) will, and, if necessary, will not
do
(3) Describe the application of the software being specified, including rel
evant benefits, objectives, and goals
(4) Be consistent with similar statements in higher-level specifications if
they exist
This should be an executive-level summary. Do not enumerate the whole requireme
nts list here.
1.3 Definitions, Acronyms, and Abbreviations.
Provide the definitions of all terms, acronyms, and abbreviations required to pr
operly interpret the SRS. This information may be provided by reference to one
or more appendices in the SRS or by reference to documents. This information may
be provided by reference to an Appendix.
1.4 References
In this subsection:
(1) Provide a complete list of all documents referenced elsewhere in the SRS
(2) Identify each document by title, report number (if applicable), date, and p
ublishing organization
(3) Specify the sources from which the references can be obtained.
This information can be provided by reference to an appendix or to another docum
ent. If your application uses specific protocols or RFC’s, then reference them he
re so designers know where to find them.
1.5 Overview
In this subsection:
(1) Describe what the rest of the SRS contains
(2) Explain how the SRS is organized
Don’t rehash the table of contents here. Point people to the parts of the documen
t they are most concerned with. Customers/potential users care about section 2,
developers care about section 3.
2. The Overall Description
Describe the general factors that affect the product and its requirements. This
section does not state specific requirements. Instead, it provides a backgroun
d for those requirements, which are defined in section 3, and makes them easier
to understand. In a sense, this section tells the requirements in plain English
for the consumption of the customer. Section3 will contain a specification writ
ten for the developers.
2.1 Product Perspective
Put the product into perspective with other related products. If the product i
s independent and totally self-contained, it should be so stated here. If the S
RS defines a product that is a component of a larger system, as frequently occur
s, then this subsection relates the requirements of the larger system to functio
nality of the software and identifies interfaces between that system and the sof
tware. If you are building a real system,compare its similarity and differences
to other systems in the marketplace. If you are doing a research-oriented proj
ect, what related research compares to the system you are planning to build.
A block diagram showing the major components of the larger system, interconnecti
ons, and external interfaces can be helpful. This is not a design or architectu
re picture. It is more to provide context, especially if your system will inter
act with external actors. The system you are building should be shown as a blac
k box. Let the design document present the internals.
The following subsections describe how the software operates inside various cons
traints.
2.1.1 System Interfaces
List each system interface and identify the functionality of the software to acc
omplish the system requirement and the interface description to match the system
. These are external systems that you have to interact with. For instance, if
you are building a business application that interfaces with the existing employ
ee payroll system, what is the API to that system that designer’s will need to use
?
2.1.2 Interfaces
Specify:
(1) The logical characteristics of each interface between the software produ
ct and its users.
(2) All the aspects of optimizing the interface with the person who must use
the system
This is a description of how the system will interact with its users. Is there
a GUI, a command line or some other type of interface? Are there special interf
ace requirements? If you are designing for the general student population for i
nstance, what is the impact of ADA (American with Disabilities Act) on your inte
rface?
2.1.3 Hardware Interfaces
Specify the logical characteristics of each interface between the software produ
ct and the hardware components of the system. This includes configuration chara
cteristics. It also covers such matters as what devices are to be supported, ho
w they are to be supported and protocols. This is not a description of hardware
requirements in the sense that “This program must run on a Mac with 64M of RAM”. T
his section is for detailing the actual hardware devices your application will i
nteract with and control. For instance, if you are controlling X10 type home de
vices, what is the interface to those devices? Designers should be able to look
at this and know what hardware they need to worry about in the design. Many bu
siness type applications will have no hardware interfaces. If none, just state “T
he system has no hardware interface requirements” If you just delete sections tha
t are not applicable, then readers do not know if: a. this does not apply or b.
you forgot to include the section in the first place.
2.1.4 Software Interfaces
Specify the use of other required software products and interfaces with other ap
plication systems. For each required software product, include:
(1) Name
(2) Mnemonic
(3) Specification number
(4) Version number
(5) Source
For each interface, provide:
(1) Discussion of the purpose of the interfacing software as related to this
software product
(2) Definition of the interface in terms of message content and format
Here we document the APIs, versions of software that we do not have to write, bu
t that our system has to use. For instance if your customer uses SQL Server 7
and you are required to use that, then you need to specify i.e.
2.1.4.1 Microsoft SQL Server 7. The system must use SQL Server as its database
component. Communication with the DB is through ODBC connections. The system m
ust provide SQL data table definintions to be provided to the company DBA for se
tup.
A key point to remember is that you do NOT want to specify software here that yo
u think would be good to use. This is only for customer-specified systems that
you have to interact with. Choosing SQL Server 7 as a DB without a customer req
uirement is a Design choice, not a requirement. This is a subtle but important p
oint to writing good requirements and not over-constraining the design.
2.1.5 Communications Interfaces
Specify the various interfaces to communications such as local network protocols
, etc. These are protocols you will need to directly interact with. If you hap
pen to use web services transparently to your application then do not list it he
re. If you are using a custom protocol to communicate between systems, then doc
ument that protocol here so designers know what to design. If it is a standard
protocol, you can reference an existing document or RFC.
2.1.6 Memory Constraints
Specify any applicable characteristics and limits on primary and secondary memor
y. Don’t just make up something here. If all the customer’s machines have only 128K
of RAM, then your target design has got to come in under 128K so there is an ac
tual requirement. You could also cite market research here for shrink-wrap type
applications “Focus groups have determined that our target market has between 256
-512M of RAM, therefore the design footprint should not exceed 256M.” If there ar
e no memory constraints, so state.
2.1.7 Operations
Specify the normal and special operations required by the user such as:
(1) The various modes of operations in the user organization
(2) Periods of interactive operations and periods of unattended operations
(3) Data processing support functions
(4) Backup and recovery operations
(Note: This is sometimes specified as part of the User Interfaces section.) If
you separate this from the UI stuff earlier, then cover business process type s
tuff that would impact the design. For instance, if the company brings all thei
r systems down at midnight for data backup that might impact the design. These
are all the work tasks that impact the design of an application, but which might
not be located in software.
2.1.8 Site Adaptation Requirements
In this section:
(1) Define the requirements for any data or initialization sequences that ar
e specific to a given site, mission, or operational mode
(2) Specify the site or mission-related features that should be modified to
adapt the software to a particular installation
If any modifications to the customer’s work area would be required by your system,
then document that here. For instance, “A 100Kw backup generator and 10000 BTU a
ir conditioning system must be installed at the user site prior to software inst
allation”.
This could also be software-specific like, “New data tables created for this syste
m must be installed on the company’s existing DB server and populated prior to sys
tem activation.” Any equipment the customer would need to buy or any software set
up that needs to be done so that your system will install and operate correctly
should be documented here.
2.2 Product Functions
Provide a summary of the major functions that the software will perform. Sometim
es the function summary that is necessary for this part can be taken directly fr
om the section of the higher-level specification (if one exists) that allocates
particular functions to the software product.
For clarity:
(1) The functions should be organized in a way that makes the list of functi
ons understandable to the customer or to anyone else reading the document for th
e first time.
(2) Textual or graphic methods can be used to show the different functions a
nd their relationships. Such a diagram is not intended to show a design of a pr
oduct but simply shows the logical relationships among variables.
AH, Finally the real meat of section 2. This describes the functionality of the
system in the language of the customer. What specifically does the system that
will be designed have to do? Drawings are good, but remember this is a descrip
tion of what the system needs to do, not how you are going to build it. (That co
mes in the design document).
2.3 User Characteristics
Describe those general characteristics of the intended users of the product incl
uding educational level, experience, and technical expertise. Do not state spec
ific requirements but rather provide the reasons why certain specific requiremen
ts are later specified in section 3.
What is it about your potential user base that will impact the design? Their ex
perience and comfort with technology will drive UI design. Other characteristic
s might actually influence internal design of the system.
2.4 Constraints
Provide a general description of any other items that will limit the developer s
options. These can include:
(1) Regulatory policies
(2) Hardware limitations (for example, signal timing requirements)
(3) Interface to other applications
(4) Parallel operation
(5) Audit functions
(6) Control functions
(7) Higher-order language requirements
(8) Signal handshake protocols (for example, XON-XOFF, ACK-NACK)
(9) Reliability requirements
(10) Criticality of the application
(11) Safety and security considerations
This section captures non-functional requirements in the customers language. A
more formal presentation of these will occur in section 3.
2.5 Assumptions and Dependencies
List each of the factors that affect the requirements stated in the SRS. These
factors are not design constraints on the software but are, rather, any changes
to them that can affect the requirements in the SRS. For example, an assumption
might be that a specific operating system would be available on the hardware de
signated for the software product. If, in fact, the operating system were not a
vailable, the SRS would then have to change accordingly.
This section is catch-all for everything else that might influence the design of
the system and that did not fit in any of the categories above.
2.6 Apportioning of Requirements.
Identify requirements that may be delayed until future versions of the system.
After you look at the project plan and hours available, you may realize that you
just cannot get everything done. This section divides the requirements into di
fferent sections for development and delivery. Remember to check with the custo
mer – they should prioritize the requirements and decide what does and does not ge
t done. This can also be useful if you are using an iterative life cycle model
to specify which requirements will map to which interation.
3. Specific Requirements
This section contains all the software requirements at a level of detail suffici
ent to enable designers to design a system to satisfy those requirements, and te
sters to test that the system satisfies those requirements. Throughout this sec
tion, every stated requirement should be externally perceivable by users, operat
ors, or other external systems. These requirements should include at a minimum
a description of every input (stimulus) into the system, every output (response)
from the system and all functions performed by the system in response to an inp
ut or in support of an output. The following principles apply:
(1) Specific requirements should be stated with all the characteristics of a
good SRS
• correct
• unambiguous
• complete
• consistent
• ranked for importance and/or stability
• verifiable
• modifiable
• traceable
(2) Specific requirements should be cross-referenced to earlier documents th
at relate
(3) All requirements should be uniquely identifiable (usually via numbering
like 3.1.2.3)
(4) Careful attention should be given to organizing the requirements to maxi
mize readability (Several alternative organizations are given at end of document
)
Before examining specific ways of organizing the requirements it is helpful to u
nderstand the various items that comprise requirements as described in the follo
wing subclasses. This section reiterates section 2, but is for developers not t
he customer. The customer buys in with section 2, the designers use section 3 t
o design and build the actual application.
Remember this is not design. Do not require specific software packages, etc unl
ess the customer specifically requires them. Avoid over-constraining your desig
n. Use proper terminology:
The system shall… A required, must have feature
The system should… A desired feature, but may be deferred til later
The system may… An optional, nice-to-have feature that may never make it to impl
ementation.
Each requirement should be uniquely identified for traceability. Usually, they
are numbered 3.1, 3.1.1, 3.1.2.1 etc. Each requirement should also be testable.
Avoid imprecise statements like, “The system shall be easy to use” Well no kiddin
g, what does that mean? Avoid “motherhood and apple pie” type statements, “The system
shall be developed using good software engineering practice”
Avoid examples, This is a specification, a designer should be able to read this
spec and build the system without bothering the customer again. Don’t say things
like, “The system shall accept configuration information such as name and address
.” The designer doesn’t know if that is the only two data elements or if there are
200. List every piece of information that is required so the designers can buil
d the right UI and data tables.
3.1 External Interfaces
This contains a detailed description of all inputs into and outputs from the sof
tware system. It complements the interface descriptions in section 2 but does n
ot repeat information there. Remember section 2 presents information oriented to
the customer/user while section 3 is oriented to the developer.
It contains both content and format as follows:
• Name of item
• Description of purpose
• Source of input or destination of output
• Valid range, accuracy and/or tolerance
• Units of measure
• Timing
• Relationships to other inputs/outputs
• Screen formats/organization
• Window formats/organization
• Data formats
• Command formats
• End messages
3.2 Functions
Functional requirements define the fundamental actions that must take place in t
he software in accepting and processing the inputs and in processing and generat
ing the outputs. These are generally listed as “shall” statements starting with "Th
e system shall…
These include:
• Validity checks on the inputs
• Exact sequence of operations
• Responses to abnormal situation, including
• Overflow
• Communication facilities
• Error handling and recovery
• Effect of parameters
• Relationship of outputs to inputs, including
• Input/Output sequences
• Formulas for input to output conversion
3. Specific Requirements
3.1 External interface requirements
3.1.1 User interfaces
3.1.2 Hardware interfaces
3.1.3 Software interfaces
3.1.4 Communications interfaces
3.2 Functional requirements
3.2.1 User class 1
3.2.1.1 Functional requirement 1.1
.....
3.2.1.n Functional requirement 1.n
3.2.2 User class 2
.....
3.2.m User class m
3.2.m.1 Functional requirement m.1
.....
3.2.m.n Functional requirement m.n
3.3 Performance Requirements
3.4 Design Constraints
3.5 Software system attributes
3.6 Other requirements
3 Specific Requirements
3.1 External interface requirements
3.1.1 User interfaces
3.1.2 Hardware interfaces
3.1.3 Software interfaces
3.1.4 Communications interfaces
3.2 Functional requirements
3.2.1 Stimulus 1
3.2.1.1 Functional requirement 1.1
.....
3.2.1.n Functional requirement 1.n
3.2.2 Stimulus 2
.....
3.2.m Stimulus m
3.2.m.1 Functional requirement m.1
.....
3.2.m.n Functional requirement m.n
3.3 Performance Requirements
3.4 Design Constraints
3.5 Software system attributes
3.6 Other requirements
3 Specific Requirements
3.1 External interface requirements
3.1.1 User interfaces
3.1.2 Hardware interfaces
3.1.3 Software interfaces
3.1.4 Communications interfaces
3.2 Functional requirements
3.2.1 Information flows
3.2.1.1 Data flow diagram 1
3.2.1.1.1 Data entities
3.2.1.1.2 Pertinent processes
3.2.1.1.3 Topology
3.2.1.2 Data flow diagram 2
3.2.1.2.1 Data entities
3.2.1.2.2 Pertinent processes
3.2.1.2.3 Topology
.....
3.2.1.n Data flow diagram n
3.2.1.n.1 Data entities
3.2.1.n.2 Pertinent processes
3.2.1.n.3 Topology
3.2.2 Process descriptions
3.2.2.1 Process 1
3.2.2.1.1 Input data entities
3.2.2.1.2 Algorithm or formula of process
3.2.2.1.3 Affected data entities
3.2.2.2 Process 2
3.2.2.2.1 Input data entities
3.2.2.2.2 Algorithm or formula of process
3.2.2.2.3 Affected data entities
.….
3.2.2.m Process m
3.2.2.m.1 Input data entities
3.2.2.m.2 Algorithm or formula of process
3.2.2.m.3 Affected data entities
3.2.3 Data construct specifications
3.2.3.1 Construct 1
3.2.3.1.1 Record type
3.2.3.1.2 Constituent fields
3.2.3.2 Construct 2
3.2.3.2.1 Record type
3.2.3.2.2 Constituent fields
…..
3.2.3.p Construct p
3.2.3.p.1 Record type
3.2.3.p.2 Constituent fields
3.2.4 Data dictionary
3.2.4.1 Data element 1
3.2.4.1.1 Name
3.2.4.1.2 Representation
3.2.4.1.3 Units/Format
3.2.4.1.4 Precision/Accuracy
3.2.4.1.5 Range
3.2.4.2 Data element 2
3.2.4.2.1 Name
3.2.4.2.2 Representation
3.2.4.2.3 Units/Format
3.2.4.2.4 Precision/Accuracy
3.2.4.2.5 Range
…..
3.2.4.q Data element q
3.2.4.q.1 Name
3.2.4.q.2 Representation
3.2.4.q.3 Units/Format
3.2.4.q.4 Precision/Accuracy
3.2.4.q.5 Range
3.3 Performance Requirements
3.4 Design Constraints
3.5 Software system attributes
3.6 Other requirements
Outline for SRS Section 3
Showing multiple organizations (Can’t decide? Then glob it all together)
3 Specific Requirements
3.1 External interface requirements
3.1.1 User interfaces
3.1.2 Hardware interfaces
3.1.3 Software interfaces
3.1.4 Communications interfaces
3.2 Functional requirements
3.2.1 User class 1
3.2.1.1 Feature 1.1
3.2.1.1.1 Introduction/Purpose of feature
3.2.1.1.2 Stimulus/Response sequence
3.2.1.1.3 Associated functional requirements
3.2.1.2 Feature 1.2
3.2.1.2.1 Introduction/Purpose of feature
3.2.1.2.2 Stimulus/Response sequence
3.2.1.2.3 Associated functional requirements
…..
3.2.1.m Feature 1.m
3.2.1.m.1 Introduction/Purpose of feature
3.2.1.m.2 Stimulus/Response sequence
3.2.1.m.3 Associated functional requirements
3.2.2 User class 2
.....
3.2.n User class n
.....
3.3 Performance Requirements
3.4 Design Constraints
3.5 Software system attributes
3.6 Other requirements