Requirements Document Template
Requirements Document Template
Requirements Document
Department/Group
Region
Telephone
Contributors
Department/Group
Region
Telephone
Description of Revision
Region
Revision History
Version
Date
Requirements Document
Document Template Final Sign-Off Section
Approved by
Business Application Owner: <Type name here>
Date:
Signature:
Comments:
Business Area Partner: <Type name here>
Date:
Signature:
Comments:
Business Segment Partner: <Type name here>
Date:
Signature:
Comments:
Development Manager and / or Development Team Lead: <Type name here>
Date:
Signature:
Comments:
IT Project Manager: <Type name here>
Date:
Signature:
Comments:
National Operations Project Manager: <Type name here>
Date:
Signature:
Comments:
Quality Consultant: <Type name here>
Date:
Signature:
Comments:
Realization Team Leader: <Type name here>
Date:
Signature:
Comments:
Requirements Document
Document Template Final Sign-Off Section
Approved by
Solution Consultant: <Type name here>
Date:
Signature:
Comments:
<Other Approval>: <Type name here>
Date:
Signature:
Comments:
Requirements Document
Contents
Contents
[To update the Contents, click inside the table of contents and press the F9 key.]
Document Template Final Sign-Off Section......................................................................................... 2
1 Document Overview.............................................................................6
1.1
Purpose..........................................................................................................6
1.2
Instructions....................................................................................................6
2 Executive Summary..............................................................................7
3 Business Requirement.........................................................................8
3.1
Requirement Sources...................................................................................8
3.2
Business Objectives.....................................................................................8
3.3
Context Diagram............................................................................................9
3.4
Events...........................................................................................................12
3.5
Processes.....................................................................................................12
3.5.1
<Process1>.......................................................................................................................... 13
4 Change Matrix.....................................................................................19
4.1
New Requirements......................................................................................19
4.2
Deleted Requirements.................................................................................19
4.3
Modified Requirements...............................................................................19
User Requirements......................................................................................20
5.2
Functional Requirements...........................................................................20
5.3
Non-Functional Requirements...................................................................21
5.4
System Requirements.................................................................................21
Requirements Document
Contents
Requirements Document
Document Overview
1 Document Overview
1.1 Purpose
The Requirements Document is critical to successfully define the business requirements
and support the development of the technical solution. This document should be the
single record of reference for requirements pertaining to this initiative. The process of
gathering requirements is one of progressive elaboration.
When completed, this document is placed under change control to preserve a record of
what has been agreed to, and approved.
1.2 Instructions
Delete the instructions blue text and this page when completing this template for an
initiative. Replace text in angle brackets (<>) with opportunity-specific content, or
delete if it not applicable. Retain other content in angle brackets unless there is a
compelling reason to remove.
SOLUTION REVIEW CRITERIA: Tables, figures, embedded files, and other non-text
objects should have text that describes the purpose of the object and any color or notation
conventions used in the object. Tables should also include descriptions of the columns if
not obvious to a layperson, and especially the meaning of encoded data values. Tables
and Figures should be captioned and listed in an appropriate table of contents. Standard
diagrams techniques can just be referenced (e.g., Ouellette context diagrams), but any
non-standard deviations (e.g., dashed lines) must be documented. Authors should use best
practices in the development of their documents. At a minimum:
styles
Blank paragraphs are not used for inter-paragraph spacing
Embedded change bars include only if they are relative to a prior reviewed
version; documents up for first review should have no change bars
Requirements Document
Appendix II Traceability Matrix
2 Executive Summary
Write the Executive Summary for a business audience, assuming no detailed knowledge
of the business opportunity area, and define any acronyms that are used. It should be brief
and descriptive, but it does not replace any content from later sections.
A recommended flow for the paragraphs:
Describe the general business context.
SOLUTION REVIEW CRITERIA: Should be less than 1 page, clear and understandable
by a lay reader.
Requirements Document
Appendix II Traceability Matrix
3 Business Requirement
3.1 Requirement Sources
This section should identify the sources for the business requirements. For instance, if the
project is regulatory in nature then this section should include a summary of the
regulations that must be met by the requirements. If the project scope is to solve a
specific business problem, describe the background of the problem and where it
originated. These sources should be included in CaliberRM under the Sources category.
Sources can come from vision statements, business cases, and similar types of
information that business partners develop in the QI and Concept phase.
SOLUTION REVIEW CRITERIA: Clear understanding of where the requirements
originated.
Table 2. Requirement Sources
Source ID
Summary
List the Business Objectives in a table, numbered for traceability. This list should be
inclusive of all stakeholders viewpoints. In theory, every part of the solution created in
Definition and developed during Development should trace back to one or more of these
Requirements Document
Appendix II Traceability Matrix
Goals should fall within the scope of the original Qualified Idea; Goals
outside of the QI should indicate how they were derived.
The following table lists the customer business objectives for this project.
Table 3. Customer Business Objectives
Objective#
Requirement Description
Priority
Requirements Document
Appendix II Traceability Matrix
Each box represents an entity (e.g. department, organization vendor) that is external to
the scope of the project but triggers an event which must be responded to within the
project scope. Each box should be identified with the business organization name (not a
system name) and should be numbered.
Each line represents a business data flow and should be labeled with a clear description
of the type of data flowing into/out of the project scope (bubble). Once each line is
labeled, identify the event which triggers the flow and include the event number on the
flow. Number each flow.
The Context Diagram should have a supporting table included that lists of the flows on
the Context Diagram. The flow description should focus on the high-level event and
business response; showing all of the subsequent flows in response to an event is
probably too much detail. For instance, showing an acknowledgement response to a
business message is not appropriate.
Multiple Context Diagrams can be included for large programs, where the extra detail
adds to the clarity of the overall presentation. If done, include an overarching diagram
that places all the individual Context Diagrams in context.
The figure below is a sample context diagram.
Requirements Document
Appendix II Traceability Matrix
Identify the External Entities that participate in the Context Diagram. These tables help
to scope the analysis work performed in Definition. Provide a list of the business units,
organizations, and potential deployment sites affected by the initiative. Entities should
not be IT applications, but the Business Area, Department, Function, Services provided
by the entity. The Business Impact should be a synopsis of the anticipated impact; this
impact should state known changes as a result of the project. Definition will produce the
complete impact analysis. Impacts to External Entities are responsibilities for that area to
help realize the objectives or conform to new or changed information flows. Use
appendices to capture detailed information on systems, sites and organizations, such as
business owners and contact information.
Table 4. External Entities
Name
Description
Business Impact
EE1
EE2
Identify the Business Entities that are in scope for the process. The business impact
should state known changes as a result of the project.
Table 5. Business Entities in Project Scope
Name
Description
Business Impact
EE1
EE2
List out each information flow identified on the Context Diagram along with a
description and business impact. The business impact should state known changes as a
result of the project. Indicate which business event number from the Event List table in
the next section that triggered the flow.
Table 6. Information Flows
Name
Description
Business Impact
Event
BF1
BF2
Requirements Document
Appendix II Traceability Matrix
3.4 Events
The following business events that occur trigger planned processes that will be impacted
as a result of this project. There are two types of events.
1. External Event - an event initiated by a specific originating adjacent system.
2. Temporal Event - an event initiated by the arrival or passage of a specific time.
These events are usually associated with in-bound data flows on the Context Diagram.
Outbound flows are associated with the response processing of these events. External
Events are identified with an identifier beginning with E and Temporal by a T.
List the entity which triggered the event, name of the event, and the associated process
which is required to respond the event. Describe the process as it pertains to the scope of
the project.
Table 7. Event List
Event
#
Triggering
Entity
Triggering Event
Process Name
Description
E1
3.5 Processes
This section details the processes that handle the above events. Generally a process will
have a single trigger event and will generate the required responses to that event.
Sometimes a single process may be used to handle similar events from different sources.
Processes should be named with a verb-noun combination with the verb representing
the work the system must do and the noun specifying the output of the work performed.
Each event identified above must be associated with a process which handles that
event. All outbound data flows on the Context Diagram must also be associated with
a process.
A process will generally be associated with a User Requirement. Often this
User Requirement serves as a high level description of the process. The detail of the
process should be described by a use case (described further below.)
The use case should list the steps involved in the process, the project impacts, the
business flows represented by each step and identify the functional or non-functional
requirement that is the result of the project impact. Focus on the high level steps in the
process or any steps that will require a change and will result in a requirement. Each
impact must have a corresponding requirement(s). Each requirement may be functional or
non-functional as described in section 3.4.
Requirements Document
Appendix II Traceability Matrix
3.5.1 <Process1>
3.5.1.1 Process Description
Provide a summary of the process, focusing on the changes that are necessary as a result
of the project. Identify what the task is that the user is trying to complete.
3.5.1.2 Triggering Event (s)
List the event(s) which triggered this process. In some cases there may be more then one
that triggers the same process.
3.5.1.3 User Requirements
User requirements describe user goals or tasks that the users must be able to perform. List
out each function the business must be able to perform as a user requirement. These
requirements should appear in CaliberRM under category User Requirements and should
reflect t
Table 8. User Requirements
User Req #
Requirement Description
Priority
DE-UR001
Requirements Document
Appendix II Traceability Matrix
Label the line with a clear title denoting the data represented by the flow
Indicate data stores with a rectangle with right side open. These data stores
indicate stores of information which are updated or read from during the process.
Below the diagram, provide a list of the business flows along with a
description and data elements included in the flow that are relevant to this process.
Below the diagram, provide a list of the data stores identified on the diagram
along with a description.
Describe each of the information flows identified on the diagram and include project
relevant data elements that are part of the flow. Identify whether the flow is new,
modified or existing in the Type field.
Include a unique ID for each flow or sort the flows alphabetically so they are easily found
in the list.
2013 Kaiser Foundation Health Plan, Inc. - Confidential
requirements_document
Requirements Document
Appendix II Traceability Matrix
ID
Name
Description
Data Elements
Type
E1-1
E2-2
ID
Name
Description
Actors
Identify the Actors this generally a list of the externally entities and data stores involved in the use
case
1. <Entity A>
2. <Entity B>
3. <Data Store A>
Assumptions
Requirements Document
Appendix II Traceability Matrix
Pre-Conditions
Identify all Pre-conditions that must be met prior to the process beginning.
1. <Pre-condition 1>
2. <Pre-condition 2>
3. <Pre-condition 3>
Project Impact
Info Flow
ID
Requirement
IDs
1.
Informatio
n Flow ID
from the
EventResponse
Diagram
Functional
and NonFunctional
Requirement
IDs from
Table in
following
Section
<Your text
here>
<Your text
here>
2.
Requirements Document
Appendix II Traceability Matrix
Post-conditions
Identify the post conditions that would indicate successful completion of the process including exception
handling post conditions.
1. <Post-condition 1>
2. <Post-condition 2>
3. <Post-condition 3>
Frequency Information
Indicate the processing frequency for this process.
Notes
Provide additional notes if desired that may be helpful in understanding this use case
1. <Note 1>
2. <Note 2>
Requirements Document
Appendix II Traceability Matrix
1. Requirement Number:
Each requirement has a unique number. That number conforms to a standard format.
For example, ABC-FR-XXX format for functional and ABC-NF-XXX for nonfunctional requirements, where ABC is a three-letter abbreviation for the initiative,
and XXX is a unique number. The numbering order is irrelevant, as long as the
numbers are unique. The number identifies the specific requirement throughout its
life.
2. Requirement Description:
This is the actual detailed requirement.
3. Implementation:
This indicates whether the requirement will be met by an Information Technology
system (S) or whether it will be managed manually by the business (B). If the system
or process is know, indicate it as well. This is an optional field to be used if this
information is available at the time of requirements gathering. This is subject to
change during the logical design process.
4. Region:
The region impacted by the requirement. This may be ALL or a specific region
name(s).
Table 12. <Process1> Functional Requirements
Req ID
Requirement Description
Implementation
(S/B)
Regions
Implementation
(S/B)
Regions
Req ID
Requirement Description
Requirements Document
Appendix II Traceability Matrix
4 Change Matrix
This section identifies any changes to project requirements. Through change control,
requirements will change. Document all changes here with the reason and person
responsible for the change.
Additional Date
Requirements #
Added By
Added By
Deletion Date
Requirements #
Modified
Date
Old
Requirements #
New Requirements #
Modified
By
Requirements Document
Appendix II Traceability Matrix
Req. #
User
Requirements
Source
Implementation
(B/S)
Priority
Processes
Impacted
Regions
Priority
Processes
Impacted
Regions
XXX-UR-XXX
XXX-UR-XXX
Req. #
Functional
Requirements
Source
Implementation
(B/S)
XXX-UR-XXX
XXX-UR-XXX
Requirements Document
Appendix II Traceability Matrix
Req. #
NonFunctional
Requirements
Source
Implementation
(B/S)
Priority
Processes
Impacted
Regions
Implementation
(B/S)
Priority
Processes
Impacted
Regions
XXX-NF-XXX
XXX-NF-XXX
Req. #
Systems
Requirements
Source
XXX-SR-XXX
XXX-SR-XXX
Requirements Document
Appendix II Traceability Matrix
Requirements
ID
Related
Business
Objectives
Related User
Requirements
Related
Functional
Requirements
Related NonFunctional
Requirements
Related
Systems
Requirements