Software Requirements Specification Template

bundle program package Requirements circumstantialation Template CptS 322 software organisation Engineering 9 February 2005 The spare-time activity annotated usher sh entirely be use to complete the software program Requirements Specification (SRS) assignment of WSU-TC CptS 322. The instructor moldiness approve any modifications to the overall(a) anatomical structure of this document. Template Usage Text contained deep down angle brackets () shall be replaced by your externalize- limited tuition and/or details.For example, result be replaced with both Smart Home or sensing element Network. Italicized text is holdd to curtly annotate the purpose of each ingredient within this guide. This text should not be in the final version of your submitted SRS. This cope page is not a start out of the final template and should be take before your SRS is submitted. Acknowledgements voices of this document are base upon the IEEE puff to software program Requirements Spec ification (ANSI/IEEE Std. 30-1984). The SRS templates of Dr. Orest Pilskalns (WSU, Vancover) and tinkers damn Hagemeister (WSU, Pullman) have also be utilise as guides in developing this template for the WSU-TC springtime 2005 CptS 322 course. software program Requirements Specification bunk software Engineer Prepared for WSU-TC CptS 322Software Engineering Principles I Instructor A. David McKinnon, Ph. D. Spring 2005 Revision History Date verbal description Author Comments papers Approval The following Software Requirements Specification has been accepted and authorize by the following Signature Printed account Title Date Lead Software Eng. A.David McKinnon Instructor, CptS 322 Table of Contents Revision Historyii Document Approvalii 1. Introduction1 1. 1 Purpose1 1. 2 Scope1 1. 3 Definitions, Acronyms, and Abbreviations1 1. 4 References1 1. 5 Overview1 2. General comment2 2. 1 harvesting Perspective2 2. 2 Product Functions2 2. 3 drug user Characteristics2 2. 4 General Constraints2 2. 5 Assumptions and Dependencies2 3. Specific Requirements2 3. 1 External Interface Requirements3 3. 1. 1 user Interfaces3 3. 1. 2 Hardware Interfaces3 3. 1. 3 Software Interfaces3 3. 1. 4 Communications Interfaces3 3. 2 available Requirements3 3. 2. 1 3 3. 2. 2 3 3. 3 drug abuse Cases3 3. 3. 1 Use Case 13 3. 3. 2 Use Case 23 3. Classes / Objects3 3. 4. 1 3 3. 4. 2 3 3. 5 Non-Functional Requirements4 3. 5. 1 Performance4 3. 5. 2 reliableness4 3. 5. 3 Availability4 3. 5. 4 Security4 3. 5. 5 Maintainability4 3. 5. 6 Portability4 3. 6 inverse Requirements4 3. 7 Design Constraints4 3. 8 uniform Database Requirements4 3. 9 otherwise Requirements4 4. analysis Models4 4. 1 Sequence Diagrams5 4. 3 Data prevail Diagrams (DFD)5 4. 2 claim-Transition Diagrams (STD)5 5. tack Management Process5 A. Appendices5 A. 1 concomitant 15 A. 2 Appendix 25 1. Introduction The introduction to the Software Requirement Specification (SRS) document sh ould let an overview of the complete SRS document.While writing this document delight remember that this document should contain all of the tuition needed by a software engineer to adequately envision and implement the software product exposit by the essentials tilted in this document. (Note the following section annotates are largely taken from the IEEE Guide to SRS). 1. 1 Purpose What is the purpose of this SRS and the (intended) listening for which it is written. 1. 2 Scope This arm should (1) attain the software product(s) to be produced by parent for example, Host DBMS, Report Generator, etc (2)Explain what the software product(s) leave aloneing, and, if necessary, leave behind not do (3) expose the application of the software being undertake. As a service of process of this, it should (a) Describe all relevant benefits, objectives, and goals as precisely as possible.For example, to say that bingle goal is to put forward effective historying 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 arousements in higher-level specifications (for example, the System Requirement Specification) , if they cost. What is the scope of this software product. 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 whitethorn be provided by reservoir to one or more appendixes in the SRS or by reference to opposite documents. 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 laughingstock be obtained. This information may be provided by reference to an appendix or to an other document. 1. 5 Overview This subsection should (1) Describe what the rest of the SRS contains (2) Explain how the SRS is readyd. 2. General Description This section of the SRS should describe the commonplace factors that need the product and its requirements. It should be made weak that this section does not state specific requirements it only makes those requirements easier to understand. 2. 1 Product PerspectiveThis subsection of the SRS puts the product into perspective with other related products or projects. (See the IEEE Guide to SRS for more details). 2. 2 Product Functions This subsection of the SRS should provide a summary of the functions that the software will perform. 2. 3 User Characteristics This subsection of the SRS should describe those general characteristics of the eventual users of the product that will sham the specific requirements. (See the IEEE Guide to SRS for more details).2. 4 General Constraints This subsection of the SRS s hould provide a general description of any other items that will limit the developers options for innovation the system. See the IEEE Guide to SRS for a partial derivative list of possible general constraints). 2. 5 Assumptions and Dependencies This subsection of the SRS should list each of the factors that excise the requirements stated in the SRS. These factors are not program constraints on the software solely are, or else, any careens to them that good deal affect the requirements in the SRS. For example, an assumption might be that a specific operating system will be available on the ironware designated for the software product. If, in fact, the operating system is not available, the SRS would then have to change accordingly. 3. Specific Requirements This will be the largest and most important section of the SRS.The customer requirements will be embodied within Section 2, but this section will control the D-requirements that are used to guide the projects software desi gn, implementation, and testing. Each requirement in this section should be line up Traceable (both forward and backward to prior(prenominal)/future artifacts) Unambiguous Verifiable (i. e. , testable) Prioritized (with view to importance and/or stability) Complete undifferentiated Uniquely identifiable (usually via numbering want 3. 4. 5. 6) Attention should be paid to the carefuly organize the requirements presented in this section so that they may easily accessed and understood.Furthermore, this SRS is not the software design document, therefore one should avoid the intent to over-constrain (and therefore design) the software project within this SRS. 3. 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 This section describes specific features of the software project. If desired, few requirements may be specified in the use-case format and lis ted in the Use Cases Section. 3. 2. 1 3. 2. 1. 1 Introduction 3. 2. 1. 2 Inputs 3. 2. 1. 3 Processing 3. 2. 1. 4 Outputs 3. 2. 1. 5 wrongdoing Handling 3. 2. 2 3. 3 Use Cases 3. 3. 1 Use Case 1 3. 3. 2 Use Case 2 3. 4 Classes / Objects 3. 4. 1 3. 4. 1. 1 Attributes 3. 4. 1. 2 Functions 3. 4. 2 3. 5 Non-Functional RequirementsNon-functional requirements may exist for the following attributes. Often these requirements must be achieved at a system-wide level rather than at a unit level. demesne the requirements in the following sections in measurable terms (e. g. , 95% of transaction shall be processed in less than a second, system downtime may not die 1 minute per mean solar day, gt 30 day MTBF value, etc). 3. 5. 1 Performance 3. 5. 2 Reliability 3. 5. 3 Availability 3. 5. 4 Security3. 5. 5 Maintainability 3. 5. 6 Portability 3. 6 Inverse Requirements State any *useful* inverse requirements. 3. 7 Design Constraints Specify design constrains compel by other standards, company policies, hardware limitation, etc. hat will sham this software project. 3. 8 Logical Database Requirements volition a selective informationbase be used? If so, what reproducible requirements exist for data formats, storage capabilities, data retention, data integrity, etc. 3. 9 Other Requirements Catchall section for any additional requirements. 4. Analysis Models List all analysis nonpluss used in developing specific requirements previously given in this SRS. Each model should include an introduction and a account description. Furthermore, each model should be trackable the SRSs requirements. 4. 1 Sequence Diagrams 4. 3 Data Flow Diagrams (DFD) 4. 2 State-Transition Diagrams (STD) 5. Change Management ProcessIdentify and describe the process that will be used to update the SRS, as needed, when project scope or requirements change. Who can submit changes and by what means, and how will these changes be approved. A. Appendices Appendices may be used to provide additional (and hopefully helpful) information. If present, the SRS should explicitly state whether the information contained within an appendix is to be considered as a part of the SRSs overall set of requirements. Example Appendices could include (initial) conceptual documents for the software project, marketing materials, transactions of meetings with the customer(s), etc. A. 1 Appendix 1 A. 2 Appendix 2