Project Enhancement Name

advertisement
Project Enhancement Name
Document Version 1.0
Prepared by Jane Doe, ITS
Last Edited July 23, 2016
PLAN
REQUIREMENTS
SOLUTION
ANALYSIS
DESIGN
BUILD
TEST
TRAIN/DEPLOY MAINTENANCE
TO THE DOCUMENT OWNER: This template is provided as a guideline and resource. The structure and instructions
give detail about what might go into a completed document. Only you and your team, however, know what will
best fit the needs of your specific effort, and you are encouraged to adapt the template as appropriate to meet
those needs.
Enhancement Request Design
For small-scale efforts, the Enhancement Request Design consolidates several design phase documents
including the Design Blueprint, Deployment Plan, and Test Plans to reduce project overhead while
providing coverage for essential project components. As enhancements by nature are applied to
currently operating systems or applications, each section focuses on changes to a system or application.
Executive Summary
Provide a summary of the scope of the new or upgraded system to be produced, focusing on the highlevel architecture and system interfaces.
Design
System Architecture Changes
Provide and describe a figure that depicts the system architecture changes. This figure should illustrate
the proposed new state for the system architecture, and the differences between the current and new
states should be outlined.
System Interface Changes
Describe changes that will be made to the interfaces into the system, including graphical, programmatic,
and intra-component interfaces, as well as any new interfaces to be added. This can include diagrams to
illustrate the intended changes.
Data Changes
Describe changes that will be made to the high-level data objects that will be handled by the system and
define each change from the perspective of the business process.
Page 1 of 4
Project Enhancement Name
Document Version 1.0
Data Conversion and Migration
Provide a description of data which will need to be converted and/or migrated as part of the
enhancement. Describe specific transformation details as appropriate, and describe how data will be
validated prior to and following the conversion and/or migration.
Auditing and Logging Changes
Describe changes to the logging features of the system and the data which will be captured for logging
and auditing purposes. This may include data retention, purging, or storage security.
Monitoring and Service Statistics Changes
Describe changes to the mechanism(s) for monitoring the availability and response of the system,
including notification in the event of failure.
Environment Changes
Describe changes to the different system environments, including those for development and testing as
well as production. Provide and describe a figure for each environment in the proposed new state.
Test Plan
Test Scope
Describe the parts of the system which will be tested, including features and infrastructural elements.
Clearly define the parts of the system which will not be tested during this change, along with the reasons
for exclusion.
Test Approach
Different efforts will require different types of testing. List the appropriate types for your project, taking
into consideration: unit, functional, system / integration, accessibility, performance, security, browser
and device compatibility, documentation, failure, and regression. (See the Comprehensive Test Plan
template for descriptions of each.). Document who will perform testing, at what points in the project.
Will all testing types be executed in each environment? Will specific tools or data need to be created for
testing?
Features to be Tested and Test Process
Identify the methods and criteria used in performing test activities. Define the input methods and
procedures for each type of test. Define the detailed criteria for evaluating test results. Efforts requiring
more extensive testing should use a either the Functional Test Plan and/or the Non-Functional Test Plan
templates. Document the location of those test cases here.
Enhancement Request Design Template
Page 2 of 4
Project Enhancement Name
Document Version 1.0
EXAMPLE
Enhancement Component
Testing Input
Expected Result
New user_ID attribute added to
REST interface.
Call REST API with GET user_id
parameters
API returns correct parameters
or requested user_id.
Provide more explicit error
messaging in interface.
Enter invalid data into form.
New error messaging presented
to user.
Deployment Overview
Provide an overall description of the deployment of the enhancements. If the enhancements will adhere
to the current deployment cycle and methodology, note that here. Any deviations should be noted below.
Assessment of Deployment Readiness
Describe the method for assessing deployment readiness. Identify any reviews or signoffs to be held after
the product is tested and accepted by the enhancement team and before the product is installed in the
production environment.
Deployment Steps
Outline exceptional steps which will be followed to move the product into production if the enhancement
will deviate from the normal release cycle.
Business Process Changes
List the business processes that will be modified with deployment. Outline the steps required to enable
the transition. This should include:



Engagement and training of support groups e.g. ITS Help Desk
Notifications to affected downstream systems that may require system changes based on this
enhancement
Changes to notifications the data center operators may receive regarding system health,
outages, etc.
Contingency Planning
If the contingency plan will deviate from the normal release cycle, describe the contingency plan to be
executed if problems occur during deployment activities.
Enhancement Request Design Template
Page 3 of 4
Project Enhancement Name
Document Version 1.0
Appendices
Include any additional documents that are relevant to the effort.
Revision History
Identify changes to the Enhancement Request Design Template.
Version
Date
Updater Name
Enhancement Request Design Template
Description
Page 4 of 4
Download