Technical Design Document

Information Systems Division

Technical Design Document v3.5

Project ID: <Enter Project ID>

Project Name: <Enter Project Name>
Revision Number: <Enter Revision Number>
Project Manager Name: <Enter Project Manager Name>
Document Author Name: <Enter Document Author Name>
Document Date: <Enter Date Document Last Revised>

Walmart Stores, Inc. Confidential

Table of Contents
1.

Document Purpose
1.1

2.
3.
4.
5.

Abbreviations
1
Glossary
1
Requirements
1
Technical Design 2
5.1
5.2
5.3
5.3.1
5.3.2
5.3.3

5.4
5.4.1
5.4.2
5.4.3
5.4.4

5.5
5.5.1
5.5.2
5.5.3
5.5.4

6.

Design Overview2
Out of Scope
2
Technical Architecture

6.1.1
6.1.2

6.2
6.2.1
6.2.2

6.3

Data Design

Logical Data Model......................................................................................................................... 4

Physical Data Model....................................................................................................................... 4
Data File Layouts............................................................................................................................ 4
Data Retention................................................................................................................................ 4

Infrastructure

Logical Hardware Design................................................................................................................ 4

Service Level Agreements.............................................................................................................. 6
Scalability........................................................................................................................................ 6
Backup and Recovery Plans........................................................................................................... 6

Access Control 7
Authentication................................................................................................................................. 7
Authorization................................................................................................................................... 7

Data Encryption 8
Data in Motion................................................................................................................................. 8
Data at Rest.................................................................................................................................... 8

Auditing 8

Metric Designs
7.1
7.2

Design Diagrams and Data Flow.................................................................................................... 2

Applications and Services............................................................................................................... 3
Program Specifications Requirement Mapping...............................................................................3

Security and Access

6.1

7.

Project Purpose 1

Business Metrics8
Performance Metrics

Walmart Confidential

Technical Design Document

Note: All text in blue needs to be replaced with appropriate details. If a section is not required,
do not remove section headings, enter NA and provide a brief explanation.

1. Document Purpose
The Technical Design Document (TDD) captures the high level summary of the solution being
developed to accomplish the requirements of the project. The TDD is also used to create the
Product Documentation needed to turn-over a system to Production and other documentation
necessary for installation and implementation.
Program Specifications are created after the approval of this document. See ISDLC Online
Tool for a Program Specification template. Functional and non-function requirements are to be
entered into HP Quality Center (HP QC).

1.1

Project Purpose

Insert the link to the Project Charter and Business Requirements Documents

2. Abbreviations
The following table contains common abbreviations that are used in this document.
Abbreviation

Description

3. Glossary
The following table contains unique terms and their descriptions that are used in this
document.
Term

Description

4. Requirements
Insert the name of the domain and the workspace in HP QC for the functional and nonfunctional requirements in HP QC. List the folders that contain requirements for the design.
Remember that all non-functional requirements such has service levels, availability,
security, access control, data purge, backup and recovery must be in HP QualityCenter.
The Technical Design Document must not contain any requirements.
HP QC Domain
Name
HP QC

Walmart Confidential

Page 1 of 1

Technical Design Document

Workspace
Name
HP QC Folder
Name(s)

5. Technical Design
5.1

Design Overview

Provide a high level summary of the design for the project. If the design is a subsystem of a
larger design briefly describe the larger design.

5.2

Out of Scope

Specifically call out anything that is out of scope on the design, but might be assumed as
included. Provide a reason why its not included. For example, if you are designing a
subsystem of a larger system you should be very clear about the boundaries of the subsystem
design.

5.3
5.3.1

Technical Architecture
Design Diagrams and Data Flow

Provide a diagram of the overall design, highlight the section addressed by this document (if
its a subsystem) and briefly describe how it interfaces with other components.
Insert high level diagrams for this
project (do not link them). Diagrams
should provide insight into the
components of the system and the
flow of data and messages between
them.

Call Center GUI

Network

Example:
The Customer Master Service (CMS)
can be called via SOAP from any
component. The current expected
uses are that it will be called by the
Call Center GUI and the Order
Service to obtain details about a
Customer.
When a new customer is created the
Service will post the information on a
message queue to be queried and
processed by any interested parties.

Walmart Confidential

Page 2 of 9

CRM

Order Service

New Customers

Customer Master Service

New Customer

Cache

Message
Queue
Database

Technical Design Document

The Customer Master Service will store its data in a separate data store that is not accessible
to any other component.

5.3.2

Applications and Services

The Walmart Application Portfolio and the Walmart Service Registry and Repository (WSRR)
were used to discover exiting assets and establish new assets.
CAFL: Common Application Function List

Existing Assets
App
ID

Name of
Application /
Component /
Service

Domain
Name

Owner
(group)

Exists

Major
Functionality
(CAFL)

Lifecycle
Ver

AP

WSR
R

Other

Preferred
Emerging
Declining*

Changes
Required

Yes/No

* Explanation(s) for using the declining version(s):

Proposed Assets
App
ID

Name of
Application /
Component /
Service

5.3.3

Exists
Domain
Name

Owner
(group)

Major Functionality
(CAFL)
AP

WSRR

Othe
r

Version

Program Specifications Requirement Mapping

List the program specifications known at design time with the correlated requirements. See
ISDLC the template. Also list the Application ID from the Application Portfolio and WSRR (see
section 5.3.2 Applications and Services for details).
HP QC
Requirement Id

5.4

Parent
App ID

Program Specification Name(s)

Data Design

This section describes the data models the system will use.

Walmart Confidential

Page 3 of 9

Description

Technical Design Document

5.4.1

Logical Data Model

Logical data models are graphical representation of the business requirements. They describe
the things of importance to an organization and how they relate to one another, as well as
business definitions and examples. This information can evolve during the construction phase
of the project.
Insert the logical data model diagram for the system. Include all entities and the relationships
between those entities. Provide a short narrative to describe any areas that are complex or
need to be explained. In the diagram below a Customer has many Orders and Orders have
many Items. An Order also has exactly 2 Addresses (billing, shipping).

5.4.2

Physical Data Model

Insert the physical data model diagram for the system. This can be a link to the data model
from the Data Administration team.

5.4.3

Data File Layouts

Provide the file layouts used by the system and specify the frequency required to generate
them. This can be a link to an external document.

5.4.4

Data Retention

Describe how will the requirements for data history and purges be satisfied?
Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the data retention requirements in HP QC.
HP QC Folder
Name(s)

5.5

Infrastructure

This section describes how and what infrastructure components the project will utilize.

5.5.1

Logical Hardware Design

Describe the expected hardware required for this system to operate. Provide diagrams that
show interaction of each piece of hardware. Be sure to include any functional infrastructure

Walmart Confidential

Page 4 of 9

Technical Design Document

components the system plans to use for example Databases, Web Servers, App Servers, ESB,
WSRR, Active Directory, Fire Walls, and Load Balancers etc.
Example:

Do not add requirements here. Requirements must be entered in HP QC.

Include the folder name(s) of the data volume and transfer frequency requirements in HP QC.
HP QC Folder
Name(s)

Walmart Confidential

Page 5 of 9

Technical Design Document

5.5.2

Service Level Agreements

Describe how the service levels are going to be met. For example: The creation of summary
tables or a caching strategy.
Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the service level agreements requirements in HP QC.
HP QC Folder
Name(s)

5.5.3

Scalability

Describe the plan for how the system can be scaled to address increased volumes and to
provide increased service levels/throughput.
Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the scalability requirements in HP QC.
HP QC Folder
Name(s)
Example: The Customer Master Service will be a stateless and independent service. Each
node works autonomously and requests are guaranteed to only be processed once regardless
of when and how they arrive. Scaling is achieved by adding more nodes.

The CMS Data Store is planned to be a typical relational database. Scaling it will require more
computing power on the main database machine.

5.5.4

Backup and Recovery Plans

Summarize the backup and recovery plans for this project.

How are the requirements for recovery going to be met?

Walmart Confidential

Page 6 of 9

Technical Design Document

Are the legal requirements for backup and recovery being covered?

Do not add requirements here. Requirements must be entered in HP QC.

Include the folder name(s) of the backup and recovery requirements in HP QC.
HP QC Folder
Name(s)

6. Security and Access

Define the data classification that this solution processes. Security designs are based on the
level of sensitivity of the data being processed.

6.1
6.1.1

Access Control
Authentication

Authentication is the act of establishing or confirming something (or someone) as authentic.

This might involve confirming the identity of a person or assuring that a computer program is a
trusted one.
If the system requires authentication then describe which authentication protocol(s) the system
will utilize (i.e. Kerberos, SAML, WS-Security, Certificates, etc) and how it will use it. Describe
and document all entry points into the system. If an authentication protocol is not needed,
provide the reason.
Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the authentication requirements in HP QC.
HP QC Name
Folder(s)

6.1.2

Authorization

Authorization is the function of specifying access rights to resources.

Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the authorization requirements in HP QC.
HP QC Folder
Name(s)

Walmart Confidential

Page 7 of 9

Technical Design Document

Example: AUTH 1: only users assigned the HR Staff role will be authorized to view
employee records.

6.2

Data Encryption

Data encryption is the means of ensuring that data is kept safe from corruption and that
access to it is suitably controlled. Thus data security helps to ensure privacy. It also helps in
protecting personal data. Refer to the SPS Governance website for information on data
classification and security requirements.

6.2.1

Data in Motion

Data in Motion refers to data which is being transported on any network device.
If required describe which transport protocol(s) the system will utilize (i.e. SSL, HTTPS, etc) for
data in motion. Also describe where each protocol will be used within the system. You may
need to provide or refer to diagrams in 3.5.1 (Logical Hardware Design) to describe transport
locations.

6.2.2

Data at Rest

Data at Rest refers to data which is stored in a physical location (i.e. database, file system or
storage cache).
If required, by the business or security governance, describe how you plan to secure data at
rest within the system. Include which encryption algorithms (or services) the system will
support, whether it requires keys (public/private, symmetric, etc) how and where those keys
will be stored.

6.3

Auditing

Auditing refers to tracking the events that affect the data throughout its lifespan. This includes
access to the system, access to the data, access to the logs themselves, retention periods for
the logs, and clock synchronization.
How will the design allow for auditing of lifespan of the data in the system?
Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the auditing requirements in HP QC.
HP QC Folder
Name(s)

7. Metric Designs
This section describes how the system will be monitored for its business viability, usage and
performance.

7.1

Business Metrics

Describe how the design will collect the business metrics here.

Walmart Confidential

Page 8 of 9

Technical Design Document

Do not add requirements here. Requirements must be entered in HP QC.

Include the folder name(s) of the business metrics requirements in HP QC.
HP QC Folder
Name(s)

7.2

Performance Metrics

Describe how the design will collect the performance metrics here.
Do not add requirements here. Requirements must be entered in HP QC.
Include the folder name(s) of the performance metrics requirements in HP QC.
HP QC Folder
Name(s)

Walmart Confidential

Page 9 of 9