Requirements Package Template -...
Transcript of Requirements Package Template -...
Requirements Package
for
___________________________________________
<project name>
___________________________________________
<author name>
________________________
<Date>
Version 6.0
B2T Training, L.L.C. www.b2ttraining.com Page 2 of 51
B2T Training, L.L.C. www.b2ttraining.com Page 3 of 51
Table of Contents
Project Initiation Documentation................................................................................................................................5
Project approach or methodology..........................................................................................................................5
Project Scope..........................................................................................................................................................5
Project statement of purpose............................................................................................................................5
Project objectives...............................................................................................................................................6
Project problems/opportunities.........................................................................................................................6
Business risks......................................................................................................................................................6
Project assumptions...........................................................................................................................................7
External interactions..........................................................................................................................................7
Context level dataflow diagram.........................................................................................................................8
High level processes...........................................................................................................................................9
Items out of scope..............................................................................................................................................9
Project stakeholders...............................................................................................................................................9
Requirements rules/guidelines.............................................................................................................................10
Glossary....................................................................................................................................................................11
Business Requirements.............................................................................................................................................12
Business Process Requirements............................................................................................................................12
Essential processes...........................................................................................................................................12
Essential process details...................................................................................................................................13
Business Information Requirements.....................................................................................................................15
Entities.............................................................................................................................................................15
Entity Relationship Diagram.............................................................................................................................15
B2T Training, L.L.C. www.b2ttraining.com Page 4 of 51
Attributes.........................................................................................................................................................16
Valid values/Default values..............................................................................................................................17
Relationships (Data related Business Rules).....................................................................................................18
Additional Business Rules.....................................................................................................................................20
Functional Requirements..........................................................................................................................................21
User Classes/Actors..............................................................................................................................................21
Initial Design Plan.................................................................................................................................................23
Design Phases.......................................................................................................................................................24
Functional Requirements Phase 1........................................................................................................................25
Use Case Diagram – Phase 1.................................................................................................................................25
Workflows............................................................................................................................................................26
System functionality.............................................................................................................................................27
System Use Case list.........................................................................................................................................27
System Use Case description – Use Case name................................................................................................28
User Interface Requirements................................................................................................................................29
Performance requirements..................................................................................................................................29
Security requirements..........................................................................................................................................30
Quality requirements............................................................................................................................................30
Technical Requirements............................................................................................................................................31
Appendix...................................................................................................................................................................32
Change Control Process........................................................................................................................................32
Change Control Form.......................................................................................................................................33
Revision Log..........................................................................................................................................................33
Approved Abbreviations and Acronyms...............................................................................................................35
Outstanding questions/issues...............................................................................................................................35
B2T Training, L.L.C. www.b2ttraining.com Page 5 of 51
Project Initiation Documentation
Project approach or methodology
Project Scope
Project statement of purpose
B2T Training, L.L.C. www.b2ttraining.com Page 6 of 51
Project objectives
Project problems/opportunities
ID Problems Opportunities
1
2
3
4
5
6
7
B2T Training, L.L.C. www.b2ttraining.com Page 7 of 51
ID Problems Opportunities
8
9
10
Business risks
Business risk Prob-ability
Risk response Impact
B2T Training, L.L.C. www.b2ttraining.com Page 8 of 51
Business risk Prob-ability
Risk response Impact
Project assumptions
External interactions
EXTERNAL AGENT DATA COMING FROM E.A. DATA GOING TO E.A.
B2T Training, L.L.C. www.b2ttraining.com Page 9 of 51
EXTERNAL AGENT DATA COMING FROM E.A. DATA GOING TO E.A.
Context level dataflow diagram
<sample below was built using MS Word Draw>
B2T Training, L.L.C. www.b2ttraining.com Page 10 of 51
<project name>
<external agent>
<data coming into business area>
<data going out of business area>
B2T Training, L.L.C. www.b2ttraining.com Page 11 of 51
High level processes1.
2.
3.
4.
5.
Items out of scopeThe following items/areas will not be included in this project.
Project stakeholders
Name Title Role
Project Manager Manage all aspects of the project
Executive sponsor To assure the project scope is clearly defined and correct, to assess further phases of the project
B2T Training, L.L.C. www.b2ttraining.com Page 12 of 51
Name Title Role
Internal IT Department To understand and respond to our requirements.
Quality Assurance Department To assist with verification of testable requirements and to develop the test plan and test cases.
Requirements rules/guidelinesAttribute Legend: Each Attribute name must start with its Entity name.
Abbreviation Meaning Allowable values
Column M Mandatory Y(yes) or N(no)
Column R Repeating Y(yes) or N(no)
B2T Training, L.L.C. www.b2ttraining.com Page 13 of 51
Column U Unique Y(yes) or N(no)
Grey rows Related attributes from another entity
Data types: Only four data types will be used in the business requirements. CHAR, NUMERIC, DATE, ALPHANUMERIC
Valid values: If a data element has more than 5 valid values refer to the valid values section of the document.
B2T Training, L.L.C. www.b2ttraining.com Page 14 of 51
Glossary
TERM DEFINITION
B2T Training, L.L.C. www.b2ttraining.com Page 15 of 51
Business Requirements
Business Process Requirements
Essential processes1.
B2T Training, L.L.C. www.b2ttraining.com Page 17 of 51
* - reused process
Note: hyperlinks are to the detailed process descriptions. Bookmarks are prefixed with the letter P.
B2T Training, L.L.C. www.b2ttraining.com Page 18 of 51
Essential process details<Copy this table for each process>
Process ID:
Process Name:
Detailed Description:
External Agents Involved:
What causes the process to occur?
What happens after the process is complete?
Business rules:
B2T Training, L.L.C. www.b2ttraining.com Page 19 of 51
Data (attributes): CRUD Source
Additional notes:
Information source:
Functional Requirement – AS ISList the group(s) that currently perform this process.
How is the process currently performed?
Who uses the output?
Metrics (only required if the process is a candidate for re-engineering):
How often is the process performed currently? (i.e. daily, weekly, monthly)
B2T Training, L.L.C. www.b2ttraining.com Page 20 of 51
How many occurrences of the process are completed within the above time frame?
How long does it take to perform the process in the current environment? (specify minutes or hours)
Efficiency rating (1 to 5, 1 is lowest)
Functional Requirement – Suggestions/notes for TO BEAnticipated future changes?
List the group(s) that may perform this process.
Desired time to complete process? (specify minutes or hours)
Anticipate future volumes?
Implemented in Use Case ID(s):
B2T Training, L.L.C. www.b2ttraining.com Page 21 of 51
Business Information Requirements
EntitiesEntity ID
Entity Name Unique Identifier
Number of Occurrences Owner/Author
Current Future
Note: hyperlinks are to the Glossary. When more than one attribute is included in parenthesis they represent concatenated unique identifiers.
B2T Training, L.L.C. www.b2ttraining.com Page 22 of 51
Entity Relationship Diagram
B2T Training, L.L.C. www.b2ttraining.com Page 23 of 51
AttributesLegend:
U – Unique (Y or N)
M – Mandatory (Y or N)
R – Repeating (Y or N)
<Copy this table for each entity>
Entity:
NAME
U M R Data-
Type/
Length
Valid values
Default value
Owner Definition
ID:
NAME
U M R Data-
Type/
Length
Valid values
Default value
Owner Definition
B2T Training, L.L.C. www.b2ttraining.com Page 25 of 51
Valid values/Default valuesData element name Valid values Default value
B2T Training, L.L.C. www.b2ttraining.com Page 26 of 51
Relationships (Data related Business Rules)ENTITY PAIR BUSINESS RULE AT
LEASTAT MOST
COMMENTS
B2T Training, L.L.C. www.b2ttraining.com Page 27 of 51
ENTITY PAIR BUSINESS RULE AT LEAST
AT MOST
COMMENTS
B2T Training, L.L.C. www.b2ttraining.com Page 28 of 51
ENTITY PAIR BUSINESS RULE AT LEAST
AT MOST
COMMENTS
B2T Training, L.L.C. www.b2ttraining.com Page 29 of 51
Additional Business Rules
Business Rule ID
Business Rule Related requirements components
Business Rule ID
Business Rule Related requirements components
B2T Training, L.L.C. www.b2ttraining.com Page 31 of 51
Functional Requirements
User Classes/Actors
User Class Tasks Concerns
Note: hyperlinks are to the Glossary.
B2T Training, L.L.C. www.b2ttraining.com Page 33 of 51
Initial Design Plan
Each essential process is listed below. Each process has been evaluated and rated by the project team, based on the current process efficiency and the project objectives.
Essential Process Automation
Desired
Y o N
Functional Design Business
Priority
H,M,L
Technical
Priority
H,M,L
Estimated
Cost
H, M, L
Phase Use Case ID
Essential Process Automation
Desired
Y o N
Functional Design Business
Priority
H,M,L
Technical
Priority
H,M,L
Estimated
Cost
H, M, L
Phase Use Case ID
B2T Training, L.L.C. www.b2ttraining.com Page 35 of 51
Design PhasesThe software will be designed and constructed in ______ phases.
Phase Description of work
1
2
3
B2T Training, L.L.C. www.b2ttraining.com Page 36 of 51
Functional Requirements Phase 1Based on the priorities listed above and the project budget, the following processes have been selected to be included in Phase I of the project. The design will include:
Use Case Diagram – Phase 1
System functionality
System Use Case list UC1……….
UC2………..
UC3………..
UC4………..
B2T Training, L.L.C. www.b2ttraining.com Page 39 of 51
System Use Case description – Use Case name<copy this table for each Use Case>
Use Case ID
Use Case Name
Created By
Date Created
Actor
Description
Preconditions
Post conditions
Priority
Frequency of Use
Primary Path
Actor Actions System Responses
Alternate Path 1
Actor Actions System Responses
B2T Training, L.L.C. www.b2ttraining.com Page 40 of 51
Alternate Path 2
Actor Actions System Responses
Alternate Path 3
Actor Actions System Responses
Additional Notes
Revision History Description of Change Made by Date
B2T Training, L.L.C. www.b2ttraining.com Page 41 of 51
User Interface Requirements
<Report Prototypes>
<Screen Prototypes>
Screen Field Attribute and Edit Requirements
Screen Function Description
B2T Training, L.L.C. www.b2ttraining.com Page 42 of 51
Performance requirements
Security requirements
B2T Training, L.L.C. www.b2ttraining.com Page 43 of 51
Quality requirements
B2T Training, L.L.C. www.b2ttraining.com Page 44 of 51
B2T Training, L.L.C. www.b2ttraining.com Page 45 of 51
Technical Requirements
<insert technical requirements here>
B2T Training, L.L.C. www.b2ttraining.com Page 46 of 51
Appendix
Change Control ProcessThe change control process is a procedure used by the project team to keep the project on track.
The process includes the following steps:
1. A team member formally recommends a change to the project scope.
2. The team member documents why the change is recommended.
3. The team estimates the impact of the change in terms of:
Number of hours required to complete
Project time schedule
Project quality
Project budget
Project risks
4. The team identifies alternative solutions.
5. The project sponsor decides whether the recommendation will be incorporated into the scope.
6. If the change is approved, the project scope document(s) are updated to reflect the change.
B2T Training, L.L.C. www.b2ttraining.com Page 47 of 51
Change Control Form
Requested Change:
Change Request ID:
Change request date:
Requester Name:
Requester Department:
Description of the change:
Reason for the request:
Impact of change on the project:
Estimated number of hours:
Change to implementation date:
Resources required:
Risk/Quality impact:
Approval of change:
Project Sponsor: ___________________________________
B2T Training, L.L.C. www.b2ttraining.com Page 48 of 51
Date of approval: ______________________________
Revision LogDescription of Change Made by Date
Initial Draft B2T Training Jan 2003
Added to Project Initiation Section:
Project Problems and Opportunities
Added to Process Template:
Added Additional Notes
Implemented in Use Case ID(s)
Added to Entity Template:
Entity ID
Added to Business Rules
Business Rule ID
Added to Initial Design Plan:
Business Priority
Technical Priority
Estimated Cost
Use Case ID
Added to Use Case Catalog
Added to Use Case Description:
Revision History
Additional Notes
B2T Training Jan 2004
B2T Training, L.L.C. www.b2ttraining.com Page 49 of 51
Description of Change Made by Date
Added two Screen Templates
Revised business risk table headings B2T Training June 2005
Revised and combined all stakeholders into one template
B2T Training Aug 2006
B2T Training, L.L.C. www.b2ttraining.com Page 50 of 51
Approved Abbreviations and Acronyms
Abbreviation Full Name
Outstanding questions/issues
B2T Training, L.L.C. www.b2ttraining.com Page 51 of 51