Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Software Requirements Specification for <Project> Version 1.0 approved Prepared by <author> <organization> <date created> Table of Contents Table of Contents ii Revision History ii 1. Introduction 1 1.1 Purpose 1 1.2 Document Conventions 1 1.3 Intended Audience and Reading Suggestions 1 1.4 Product Scope 1 1.5 References 1 2. Overall Description 2 2.1 Product Perspective 2 2.2 Product Functions 2 2.3 User Classes and Characteristics 2 2.4 Operating Environment 2 2.5 Design and Implementation Constraints 2 2.6 User Documentation 2 2.7 Assumptions and Dependencies 3 3. External Interface Requirements 3 3.1 User Interfaces 3 3.2 Hardware Interfaces 3 3.3 Software Interfaces 3 3.4 Communications Interfaces 3 4. System Features 4 4.1 System Feature 1 4 4.2 System Feature 2 (and so on) 4 5. Other Nonfunctional Requirements 4 5.1 Performance Requirements 4 5.2 Safety Requirements 5 5.3 Security Requirements 5 5.4 Software Quality Attributes 5 5.5 Business Rules 5 6. Other Requirements 5 Appendix A: Glossary 5 Appendix B: Analysis Models 5 Appendix C: To Be Determined List 6 Appendix D: Design Evaluation 7 Revision History Name Date Reason For Changes Version Introduction Purpose <Identify the product whose software requirements are specified in this document, including the revision or release number. Describe the scope of the product that is covered by this SRS, particularly if this SRS describes only part of the system or a single subsystem.> Product Scope <Provide a short description of the software being specified and its purpose, including relevant benefits, objectives, and goals. Relate the software to corporate goals or business strategies. If a separate vision and scope document is available, refer to it rather than duplicating its contents here.> Overall Description Product Perspective <Describe the context and origin of the product being specified in this SRS. For example, state whether this product is a follow-on member of a product family, a replacement for certain existing systems, or a new, self-contained product. If the SRS defines a component of a larger system, relate the requirements of the larger system to the functionality of this software and identify interfaces between the two. A simple diagram that shows the major components of the overall system, subsystem interconnections, and external interfaces can be helpful.> Product Functions <Summarize the major functions the product must perform or must let the user perform. Details will be provided in Section 3, so only a high level summary (such as a bullet list) is needed here. Organize the functions to make them understandable to any reader of the SRS. A picture of the major groups of related requirements and how they relate, such as a top level data flow diagram or object class diagram, is often effective.> User Classes and Characteristics <Identify the various user classes that you anticipate will use this product. User classes may be differentiated based on frequency of use, subset of product functions used, technical expertise, security or privilege levels, educational level, or experience. Describe the pertinent characteristics of each user class. Certain requirements may pertain only to certain user classes. Distinguish the most important user classes for this product from those who are less important to satisfy.> Operating Environment <Describe the environment in which the software will operate, including the hardware platform, operating system and versions, and any other software components or applications with which it must peacefully coexist.> Design and Implementation Constraints <Describe any items or issues that will limit the options available to the developers. These might include: corporate or regulatory policies; hardware limitations (timing requirements, memory requirements); interfaces to other applications; specific technologies, tools, and databases to be used; parallel operations; language requirements; communications protocols; security considerations; design conventions or programming standards (for example, if the customer’s organization will be responsible for maintaining the delivered software).> User Documentation <List the user documentation components (such as user manuals, on-line help, and tutorials) that will be delivered along with the software. Identify any known user documentation delivery formats or standards.> Assumptions and Dependencies <List any assumed factors (as opposed to known facts) that could affect the requirements stated in the SRS. These could include third-party or commercial components that you plan to use, issues around the development or operating environment, or constraints. The project could be affected if these assumptions are incorrect, are not shared, or change. Also identify any dependencies the project has on external factors, such as software components that you intend to reuse from another project, unless they are already documented elsewhere (for example, in the vision and scope document or the project plan).> External Interface Requirements User Interfaces <Describe the logical characteristics of each interface between the software product and the users. This may include sample screen images, any GUI standards or product family style guides that are to be followed, screen layout constraints, standard buttons and functions (e.g., help) that will appear on every screen, keyboard shortcuts, error message display standards, and so on. Define the software components for which a user interface is needed. Details of the user interface design should be documented in a separate user interface specification.> System Features <This template illustrates organizing the functional requirements for the product by system features, the major services provided by the product. You may prefer to organize this section by use case, mode of operation, user class, object class, functional hierarchy, or combinations of these, whatever makes the most logical sense for your product.> System Feature 1 <Don’t really say “System Feature 1.” State the feature name in just a few words.> 3.3.1 Identifier (A unique identifier for this feature, e.g. UC10) 3.3.2 Description and Priority <Provide a short description of the feature and indicate whether it is of High, Medium, or Low priority. You could also include specific priority component ratings, such as benefit, penalty, cost, and risk (each rated on a relative scale from a low of 1 to a high of 9).> 3.3.3 Stimulus/Response Sequences <List the sequences of user actions and system responses that stimulate the behavior defined for this feature. These will correspond to the dialog elements associated with use cases.> 3.3.4 Functional Requirements <Itemize the detailed functional requirements associated with this feature. These are the software capabilities that must be present in order for the user to carry out the services provided by the feature, or to execute the use case. Include how the product should respond to anticipated error conditions or invalid inputs. Requirements should be concise, complete, unambiguous, verifiable, and necessary. Use “TBD” as a placeholder to indicate when necessary information is not yet available.> <Each requirement should be uniquely identified with a sequence number or a meaningful tag of some kind.> REQ-1: REQ-2: System Feature 2 (and so on) Appendix A: Risk Assessment Software Requirements Specification for <Project> Page 1 Copyright © 1999 by Karl E. Wiegers. Permission is granted to use, modify, and distribute this document.