100% found this document useful (1 vote)
647 views15 pages

TDD Template

Download as docx, pdf, or txt
Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1/ 15

Technical Design Document (TDD)

<insert process/use case name>


Version #

Version: 1.3
Revision History

Date Version Description Author

1
Table of Contents

Table of Contents.....................................................................................................................................................2
1 Technical Design..................................................................................................................................................2
1.1 Technial Design Overview...............................................................................................................................................2
1.2 Technial Solution Architecture.......................................................................................................................................2
1.3 Technical Description of SDD..........................................................................................................................................3
2 inputs..................................................................................................................................................................4
2.1 Applications.....................................................................................................................................................................4
2.2 Variables..........................................................................................................................................................................4
2.3 Arguments.......................................................................................................................................................................5
3 Process................................................................................................................................................................6
3.1 Key Activities...................................................................................................................................................................6
4 Outputs...............................................................................................................................................................7
4.1 Target Systems................................................................................................................................................................7
4.2 Activities Leading to Outputs..........................................................................................................................................7
4.3 Reusable Components....................................................................................................................................................7
4.4 Storage/Persistence Locations for Outputs....................................................................................................................8
5 Exceptions...........................................................................................................................................................9
5.1 Known System Exceptions..............................................................................................................................................9
5.2 Business Exceptions........................................................................................................................................................9
5.3 Unknown System Exceptions........................................................................................................................................10
6 Operational and Deployment Requirements....................................................................................................11
6.1 Schedule and Operating Hours.....................................................................................................................................11
6.2 Operational Process Control.........................................................................................................................................11
6.3 Process Monitoring.......................................................................................................................................................11
7 Process Continuity.............................................................................................................................................11
7.1 System Unavailability....................................................................................................................................................11
7.2 Alerts.............................................................................................................................................................................11
7.3 Manual Intervention.....................................................................................................................................................11
8 Logging..............................................................................................................................................................11
8.1 Accessing Log Archives.................................................................................................................................................11
8.2 Key Indicators of Failure Mode.....................................................................................................................................11
9 Security.............................................................................................................................................................12
9.1 Data Privacy..................................................................................................................................................................12
9.2 Data Preservation.........................................................................................................................................................12
9.3 Encryption.....................................................................................................................................................................12
9.4 Credentials Management.............................................................................................................................................12
10 Assumptions......................................................................................................................................................12
10.1 Technical.......................................................................................................................................................................12
10.2 Functional.....................................................................................................................................................................12

2
1 DOCUMENT OVERVIEW
The Technical Solutions Document (TDD) is created for every business process that is automated using the RPA
technology. The TDD document needs to be reviewed and updated for every change requested and applied to
the automation process. This document will provide a technical snapshot of the solution and must always reflect
the latest design and key features of the automated workflow.
The purpose of the document is to record the outcome specific to the automated master project and its
subcomponents: projects, workflows, sequences etc.

2 AUTOMATED MASTER PROJECT OVERVIEW


Details filled in by the developer reflect the actual information for the master project released for production.
# Item Details
(Fill in with free text. If not applicable, mark the field as
“n/a. No empty fields.)

1 Master project name and


version

2 Robot type
(specify if the process was
automated for FOR or BOR or
mix)

3 Is Orchestrator used? (Yes/ No)

4 Scalable? (Yes/ No)


(can the process be run by
multiple robots in parallel)

3 TECHNICAL DESIGN

3.1 Technical Design Overview

In this section, complete the details in the table below.

Fields Response
Developer Name(s)
Developer Email(s)
Project Name

3
Application(s) Involved
# of Flowcharts
Appx. # of Activities
Description of Technical
Design

3.2 Technical Solution Architecture

Below, insert a screenshot of the solution architecture or accessible file path to the Technical solution.

3.3 Technical Description of SDD


In this section, copy+paste the high level process steps outlined in the SDD, and provide a brief comment about
how that solution step is accommodated from a technical point of view. If the SDD flow was provided in bullet
form, you do not need to insert the steps individually into the table – just move down a line, indent, and provide
a technical note about how it was completed
Index SDD Step Technical Solution Notes

1
2

3
4

5
6

4
4 INPUTS
In this section, please describe the inputs of the RPA Solution, and the technical details about them.

4.1 Applications
Below, list the applications where data is being accessed from.
Application Name URL/Filepath External / Type Credentials
& Version Internal required for Bot
ID

4.2 Variables
Name Input Output Description

5
4.3 Arguments
Name Input Output Description

6
5 PROCESS
In this section, for each component of technical solution architecture from above, briefly describe the purpose.
If using UiPath, use the Outline feature in the bottom right of the UiPath Studio Console to facilitate the
structure of this section.

5.1 Key Activities


Name Purpose Notes

7
6 OUTPUTS
In this section, describe the outputs of the RPA solution from a technical perspective. Using the input data &
associated processing/transformation, outline what occurs as a consequence.

6.1 Target Systems

System or Application Description of Output

6.2 Activities Leading to Outputs

Activity Description of Output

6.3 Reusable Components


Describe the RPA solution components that are performing general purpose actions/tasks that can be
potentially reused in future implementations – fill out the embedded Reusable Components WB per
project

Reusable
Components.xlsx

8
6.4 Storage/Persistence Locations for Outputs
If applicable, describe locations (network/personal drive folders, web locations, etc.) where outputs of this
process are stored

Output Folder/Location Description

9
7 EXCEPTIONS

7.1 Known System Exceptions

Step Exception Details RPA Action

7.2 Business Exceptions


Application Action Names Exception Name Description

10
7.3 Unknown System Exceptions
Any unknown alert appearing while processing may stop the automation. Below, for any potential system
exceptions, list the application name, associated action name, the name of the exception, and a description
of the result/remedy of this exception
Application Action Names Exception Name Description

11
8 OPERATIONAL AND DEPLOYMENT REQUIREMENTS

8.1 Schedule and Operating Hours


Describe any technical functionality implemented related to the scheduling of Bot activity.

8.2 Operational Process Control


Describe any process controls that users must adhere to in order to support the technical design.

8.3 Process Monitoring


Describe the monitoring requirements of this process, including log analysis, exception handling policy, variable
rework, etc.

9 PROCESS CONTINUITY
Describe how the business will respond to unusual circumstances, with reference to the business process.
Specifically, describe the technical considerations for assuring

9.1 System Unavailability

9.2 Alerts

9.3 Manual Intervention

10 LOGGING
Describe how to access log information, and how a functional user can raise issues related to information
obtained from log archives.

10.1 Accessing Log Archives

10.2 Key Indicators of Failure Mode

12
11 SECURITY

11.1 Data Privacy

11.2 Data Preservation

11.3 Encryption

11.4 Credentials Management


The following credentials are required to be configured:

Credential Name Description

12 INFRASTRUCTURE COMPONENTS
Describe the RPA solution infrastructure that is needed to enable the solution execution and operationalization
– fill out the embedded Infrastructure Components WB per project

Infrastructure
Components.xlsx

13 ASSUMPTIONS AND CONSIDERATIONS


Describe assumptions and solution considerations (technical or otherwise) that were in place during the
development of this solution that would aid in the understanding & troubleshooting of this solution.

13.1 Technical
Software:

Hardware:

Virtual Machines

13
13.2 Functional
People

Process

14

You might also like