Object Oriented Software Engineering Lab Assignment # 01: Instructions
Object Oriented Software Engineering Lab Assignment # 01: Instructions
Object Oriented Software Engineering Lab Assignment # 01: Instructions
Lab Assignment # 01
The following annotated template shall be used to complete the Software Requirements
Specification (SRS) assignment of WSU-TC CptS 322. The instructor must approve any
modifications to the overall structure of this document.
Template Usage:
Text contained within angle brackets (‘<’, ‘>’) shall be replaced by your project-specific
information and/or details. For example, <Project Name> will be replaced with either ‘Smart
Home’ or ‘Sensor Network’.
Italicized text is included to briefly annotate the purpose of each section within this template.
This text should not appear in the final version of your submitted SRS.
This cover page is not a part of the final template and should be removed before your SRS is
submitted.
Acknowledgements:
Sections of this document are based upon the IEEE Guide to Software Requirements
Specification (ANSI/IEEE Std. 830-1984). The SRS templates of Dr. Orest Pilskalns (WSU,
Vancover) and Jack Hagemeister (WSU, Pullman) have also be used as guides in developing this
template for the WSU-TC Spring 2005 CptS 322 course.
<Your Name>
Lead Software Engineer
Prepared for
WSU-TC CptS 322—Software Engineering Principles I
Instructor: A. David McKinnon, Ph.D.
Spring 2005
<Project Name>
Revision History
Document Approval
The following Software Requirements Specification has been accepted and approved by the
following:
Signature Printed Name Title Date
<Your Name> Lead Software Eng.
A. David McKinnon Instructor, CptS 322
Table of Contents
REVISION HISTORY................................................................................................................................................II
DOCUMENT APPROVAL........................................................................................................................................II
1. INTRODUCTION.....................................................................................................................................................1
1.1 PURPOSE...............................................................................................................................................................1
1.2 SCOPE...................................................................................................................................................................1
1.3 DEFINITIONS, ACRONYMS, AND ABBREVIATIONS................................................................................................1
1.4 REFERENCES.........................................................................................................................................................1
1.5 OVERVIEW............................................................................................................................................................1
2. GENERAL DESCRIPTION....................................................................................................................................2
2.1 PRODUCT PERSPECTIVE........................................................................................................................................2
2.2 PRODUCT FUNCTIONS...........................................................................................................................................2
2.3 USER CHARACTERISTICS......................................................................................................................................2
2.4 GENERAL CONSTRAINTS.......................................................................................................................................2
2.5 Assumptions and Dependencies...........................................................................................................................2
1. Introduction
The introduction to the Software Requirement Specification (SRS) document should provide an
overview of the complete SRS document. While writing this document please remember that this
document should contain all of the information needed by a software engineer to adequately
design and implement the software product described by the requirements listed in this
document. (Note: the following subsection annotates are largely taken from the IEEE Guide to
SRS).
1.1 Purpose
What is the purpose of this SRS and the (intended) audience for which it is written.
1.2 Scope
This subsection should:
(1) Identify the software product(s) to be produced by name; for example, Host DBMS, Report
Generator, etc
(2) Explain what the software product(s) will, and, if necessary, will not do
(3) Describe the application of the software being specified. As a portion of this, it should:
(a) Describe all relevant benefits, objectives, and goals as precisely as possible. For
example, to say that one goal is to provide effective reporting capabilities is not as good
as saying parameter-driven, user-definable reports with a 2 h turnaround and on-line
entry of user parameters.
(b) Be consistent with similar statements in higher-level specifications (for example, the
System Requirement Specification) , if they exist.What is the scope of this software
product.
1.4 References
This subsection should:
(1) Provide a complete list of all documents referenced elsewhere in the SRS, or in a separate,
specified document.
(2) Identify each document by title, report number - if applicable - date, and publishing
organization.
(3) Specify the sources from which the references can be obtained.
This information may be provided by reference to an appendix or to another document.
1.5 Overview
This subsection should:
(1) Describe what the rest of the SRS contains
2. General Description
This section of the SRS should describe the general factors that affect 'the product and its
requirements. It should be made clear that this section does not state specific requirements; it
only makes those requirements easier to understand.