Writing Technical Documentation Specifications (TDS) for Salesforce Project - Part 1

Writing Technical Documentation Specifications (TDS) for Salesforce Project- Part 1

Structure of TDS Document

1. Title Page
2. Table of Content
3. Document History
4. Objectives
5. Scope
6. Intended Audience
7. Document Organization
8. Objects and Fields
9. Classes
10. Triggers
11. Workflows
12. Lighting COmponents
13. Process Builder/Flow
14. Javascripts
15. Environment Setup
16. Appendix

1. Title Page

Here goes the title of the document, normally project name with client logo.

2. Table of Content

Insert TOC from word in this section.

3. Document History

Log of document updates, it can be in below format.

Document Title	Version	State	Created By	Date
	0.1	Initial Creation

4. Objectives

State the purpose of the document and what detail will be presented in the document at high level.

5. Scope

State the scope of the document in terms of what requirement's technical design is the document having.

Example: The application design outlined in this document builds upon the scope defined in the requirement phase.

6. Intended Audience

Example: 

The intended audience for this document is as follows:
▪ Development Leads – to review the design and ensure it is aligned with the end-to-end solution, development standards and guidelines.
▪ Developers – to provide them detailed development guidelines and analysis of the impacts on their relevant components.

7. Document Organization

Define structure of document at high level

Example:

This document is organized in the following sections:

Sections	Description
Objects and Fields	Contains list of added fields in both standard and custom objects
Classes	Contains list of new/modified classes which built to support the business functionality
Trigger	Contains list of triggers built as Apex code to trigger update on records based on predefined business rules and conditions
Workflow	Contains list of workflow to automate internal procedures and processes based on predefined business rules and conditions
Lightning Components / Aura	Contains list of Lightning components

Please check part 2 of this post.