需求分析文檔模板Requirements-Specification-Template

YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 1 o f 13 YourProject Requirements Specification Version 1 0 九月九月 25 2013 Use this Requirements Specification template to document the requirements for your product or service including priority and approval Tailor the specification to suit your project organizing the applicable sections in a way that works best and use the checklist to record the decisions about what is applicable and what isn t The format of the requirements depends on what works best for your project This document contains instructions and examples which are for the benefit of the person writing the document and should be removed before the document is finalized To regenerate the TOC select all CTL A and press F9 YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 2 o f 13 Table of Contents 1 EXECUTIVE SUMMARY 3 1 1PROJECT OVERVIEW 3 1 2PURPOSE AND SCOPE OF THIS SPECIFICATION 3 2 PRODUCT SERVICE DESCRIPTION 3 2 1PRODUCT CONTEXT 3 2 2USER CHARACTERISTICS 3 2 3ASSUMPTIONS 3 2 4CONSTRAINTS 3 2 5DEPENDENCIES 4 3 REQUIREMENTS 4 3 1FUNCTIONAL REQUIREMENTS 5 3 2USER INTERFACE REQUIREMENTS 5 3 3USABILITY 5 3 4PERFORMANCE 6 3 4 1Capacity 6 3 4 2Availability 6 3 4 3Latency 6 3 5MANAGEABILITY MAINTAINABILITY 6 3 5 1Monitoring 6 3 5 2Maintenance 6 3 5 3Operations 6 3 6SYSTEM INTERFACE INTEGRATION 7 3 6 1Network and Hardware Interfaces 7 3 6 2Systems Interfaces 7 3 7SECURITY 8 3 7 1Protection 8 3 7 2Authorization and Authentication 8 3 8DATA MANAGEMENT 8 3 9STANDARDS COMPLIANCE 8 3 10PORTABILITY 8 4 USER SCENARIOS USE CASES 9 5 DELETED OR DEFERRED REQUIREMENTS 9 6 REQUIREMENTS CONFIRMATION STAKEHOLDER SIGN OFF 10 APPENDIX 11 APPENDIX A DEFINITIONS ACRONYMS AND ABBREVIATIONS 11 APPENDIX B REFERENCES 11 APPENDIX C REQUIREMENTS TRACEABILITY MATRIX 11 APPENDIX D ORGANIZING THE REQUIREMENTS 13 YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 3 o f 13 1 Executive Summary 1 1Project Overview Describe this project or product and its intended audience or provide a link or reference to the project charter 1 2Purpose and Scope of this Specification Describe the purpose of this specification and its intended audience Include a description of what is within the scope what is outside of the scope of these specifications For example In scope This document addresses requirements related to phase 2 of Project A modification of Classification Processing to meet legislative mandate ABC modification of Labor Relations Processing to meet legislative mandate ABC Out of Scope The following items in phase 3 of Project A are out of scope modification of Classification Processing to meet legislative mandate XYZ modification of Labor Relations Processing to meet legislative mandate XYZ Phase 3 will be considered in the development of the requirements for Phase 2 but the Phase 3 requirements will be documented separately 2 Product Service Description In this section describe the general factors that affect the product and its requirements This section should contain background information not state specific requirements provide the reasons why certain specific requirements are later specified 2 1Product Context How does this product relate to other products Is it independent and self contained Does it interface with a variety of related systems Describe these relationships or use a diagram to show the major components of the larger system interconnections and external interfaces 2 2User Characteristics Create general customer profiles for each type of user who will be using the product Profiles should include Student faculty staff other experience technical expertise other general characteristics that may influence the product 2 3Assumptions List any assumptions that affect the requirements for example equipment availability user expertise etc For example a specific operating system is assumed to be available if the operating system is not available the Requirements Specification would then have to change accordingly 2 4Constraints Describe any items that will constrain the design options including parallel operation with an old system audit functions audit trail log files etc YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 4 o f 13 access management and security criticality of the application system resource constraints e g limits on disk space or other hardware limitations other design constraints e g design or other standards such as programming language or framework 2 5Dependencies List dependencies that affect the requirements Examples This new product will require a daily download of data from X Module X needs to be completed before this module can be built 3 Requirements Describe all system requirements in enough detail for designers to design a system satisfying the requirements and testers to verify that the system satisfies requirements Organize these requirements in a way that works best for your project See Appendix DAppendix D Organizing the Requirements for different ways to organize these requirements Describe every input into the system every output from the system and every function performed by the system in response to an input or in support of an output Specify what functions are to be performed on what data to produce what results at what location for whom Each requirement should be numbered or uniquely identifiable and prioritized See the sample requirements in Functional Requirements and System Interface Integration as well as these example priority definitions Priority Definitions The following definitions are intended as a guideline to prioritize requirements Priority 1 The requirement is a must have as outlined by policy law Priority 2 The requirement is needed for improved processing and the fulfillment of the requirement will create immediate benefits Priority 3 The requirement is a nice to have which may include new functionality It may be helpful to phrase the requirement in terms of its priority e g The value of the employee status sent to DIS must be either A or I or It would be nice if the application warned the user that the expiration date was 3 business days away Another approach would be to group requirements by priority category A good requirement is Correct Unambiguous all statements have exactly one interpretation Complete where TBDs are absolutely necessary document why the information is unknown who is responsible for resolution and the deadline Consistent Ranked for importance and or stability Verifiable avoid soft descriptions like works well is user friendly use concrete terms and specify measurable quantities Modifiable evolve the Requirements Specification only via a formal change process preserving a complete audit trail of changes Does not specify any particular design Traceable cross reference with source documents and spawned documents YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 5 o f 13 3 1Functional Requirements In the example below the requirement numbering has a scheme BR LR 0 BR for Business Requirement LR for Labor Relations For small projects simply BR would suffice Keep in mind that if no prefix is used the traceability matrix may be difficult to create e g no differentiation between 02 as a business requirement vs a test case The following table is an example format for requirements Choose whatever format works best for your project For Example Req RequirementCommentsPriority Date Rvwd SME Reviewed Approved BR LR 05 The system should associate a supervisor indicator with each job class Business Process Maintenance 37 13 04Bob Dylan Mick Jagger BR LR 08 The system should handle any number of fees existing and new associated with unions Business Process Changing Dues in the System An example of a new fee is an initiation fee 27 13 04Bob Dylan Mick Jagger BR LR 10 The system should capture and maintain job class status i e active or inactive Business Process Maintenance Some job classes are old and are no longer used However they still need to be maintained for legal contract and historical purposes 27 13 04Bob Dylan Mick Jagger BR LR 16 The system should assign the Supervisor Code based on the value in the Job Class table and additional criteria as specified by the clients April 2005 New requirement It is one of three new requirements from BR LR 03 2 BR LR 18 The system should provide the Labor Relations office with the ability to override the system derived Bargaining Unit code and the Union Code for to be determined employee types including hourly appointments April 2005 New requirement It is one of three new requirements from BR LR 04 5 11 2005 Priority changed from 2 to 3 2 3 3 2User Interface Requirements In addition to functions required describe the characteristics of each interface between the product and its users e g required screen formats organization report layouts menu structures error and other messages or function keys 3 3Usability Include any specific usability requirements for example Learnability YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 6 o f 13 The user documentation and help should be complete The help should be context sensitive and explain how to achieve common tasks The system should be easy to learn See http www usabilitynet org 3 4Performance Specify static and dynamic numerical requirements placed on the system or on human interaction with the system Static numerical requirements may include the number of terminals to be supported the number of simultaneous users to be supported and the amount and type of information to be handled Dynamic numerical requirements may include the number of transactions and tasks and the amount of data to be processed within certain time period for both normal and peak workload conditions All of these requirements should be stated in measurable form For example 95 of the transactions shall be processed in less than 1 second rather than an operator shall not have to wait for the transaction to complete 3 4 1Capacity Include measurable capacity requirements e g the number of simultaneous users to be supported the maximum simultaneous user load per user memory requirements expected application throughput 3 4 2Availability Include specific and measurable requirements for Hours of operation Level of availability required Coverage for geographic areas Impact of downtime on users and business operations Impact of scheduled and unscheduled maintenance on uptime and maintenance communications procedures reliability e g acceptable mean time between failures MTBF or the maximum permitted number of failures per hour 3 4 3Latency Include explicit latency requirements e g the maximum acceptable time or average time for a service request 3 5Manageability Maintainability 3 5 1Monitoring Include any requirements for product or service health monitoring failure conditions error detection logging and correction 3 5 2Maintenance Specify attributes of the system that relate to ease of maintenance These requirements may relate to modularity complexity or interface design Requirements should not be placed here simply because they are thought to be good design practices 3 5 3Operations Specify any normal and special operations required by the user including periods of interactive operations and periods of unattended operations YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 7 o f 13 data processing support functions backup and recovery operations safety considerations and requirements disaster recovery and business resumption 3 6System Interface Integration Specify the use of other required products e g a database or operating system and interfaces with other systems e g UWHires package interfaces with PubCookie and ODS HEPPS system interfaces with Budget system For each interface define the interface in terms of message format and content For well documented interfaces simply provide a reference to the documentation Outline each interface between the product and the hardware or network components of the system This includes configuration characteristics e g number of ports instruction sets what devices are to be supported and protocols e g signal handshake protocols 3 6 1Network and Hardware Interfaces Specify the logical characteristics of each interface between the product and the hardware or network components of the system This includes configuration characteristics e g number of ports instruction sets what devices are to be supported and protocols e g signal handshake protocols 3 6 2Systems Interfaces Example systems interface requirements A System1 to System2 Interface The will create and send a fixed length text file as an email attachment to System2mail u washington edu to be imported into the System2 system for payroll calculation This file must be received on EDIT day by 4 00 PM in order to be processed in the EDIT night run The requirements below document the file specifications data transfer process and specific schedule This file is referred to as FileName in this document File Structure and Format A1 The FileName file is a fixed length text file A2 The FileName file is an unformatted ASCII file text only A3 The FileName file contains a batch totals record and several detail records File Description Batch Totals Record A4 The batch totals record can be placed at the beginning in the middle or at the end of the file A5 The batch totals record contains the following Record Type value XA Process Type value A Batch Number 3 digit number assigned by Payroll Dept Origin Code AIG Total number of detail records Total deduction amount File Description Detail Records A6 The FileName file contains a row for each record meeting xxx criteria A7 Each row in the FileName file contains the following fields comma delimited and encased in double quotes where the data includes commas or spaces Employee Id Record Type Process Date MMDDYY XYG Number YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 8 o f 13 Element Code Amount Amount Sign Year Flag Total Amount Total Amt Sign 3 7Security 3 7 1Protection Specify the factors that will protect the system from malicious or accidental access modification disclosure destruction or misuse For example encryption activity logging historical data sets restrictions on intermodule communications data integrity checks 3 7 2Authorization and Authentication Specify the Authorization and Authentication factors Consider using standard tools such as PubCookie 3 8Data Management Specify the requirements for any information that is to be placed into a database including types of information used by various functions frequency of use data access rules data entities and relationships integrity constraints data retention valid range accuracy and or tolerance units of measure data formats default or initial values 3 9Standards Compliance Specify the requirements derived from existing standards policies regulations or laws e g report format data naming accounting procedures audit tracing For example this could specify the requirement for software to trace processing activity Such traces are needed for some applications to meet minimum regulatory or financial standards An audit trace requirement may for example state that all changes to a payroll database must be recorded in a trace file with before and after values 3 10 Portability If portability is a requirement specify attributes of the system that relate to the ease of porting the system to other host machines and or operating systems For example Percentage of components with host dependent code Percentage of code that is host dependent Use of a proven portable language Use of a particular compiler or language subset YourProject Requirements Specification y wenkufile temp2 2020 3 27 e2f46bee 2699 4397 8561 6ba3b9dca474 1b1ced62696a38f9831e313d8d74e6ad pdf九月 25 2013Page 9 o f 13 Use of a particular operating system The need for environment independence the product must operate the same regardless of operating systems networks development or production environments 4 User Scenarios Use Cases Provide a summary of the major functions that the product will perform Organize the functions to be understandable to the customer or a first time reader Include use cases and business scenarios or provide a link to a separate document or documents A business scenario Describes a significant business need Identifies documents and ranks the problem that is driving the scenario Describes the business and technical environment that will resolve the problem States the desired objectives Shows the Actors and where they fit in the business model Is specific and measurable and uses clear metrics for success 5 Deleted or Deferred Requirements Identify any requirements that have been deleted after approval or that may be delayed until future versions of the system For example Req Business Requirement StatusCommentsPri Date Rvwd SME Reviewed Approved BR LR 01 The system should validate the relationship between Bargaining Unit Location and Job Class April 2005 Deleted This requirement has been replaced by BR LR 036 and BR CC 33 Business Process Assigning a Bargaining Unit to an Appointment 17 13 04Bob Dylan Mick Jagger BR LR 02 The system should validate that the supervisor indicator is correct ac