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

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

This part is continuation of part 1.

8. Objects and Fields

State what this section will be having, e.g.. List of new custom fields added to each object as part of  project implementation.

Easy way to list down all objects and fields is using SOQL. 

Below query will return you object names starting with given prefix in SOQl criteria and fields of the objects starting with prefix given in criteria. It is good to list down only custom objects and custom fields. 

Select EntityDefinition.QualifiedApiName, QualifiedApiName,  Label,   DataType, Description  from FieldDefinition where ( EntityDefinition.QualifiedApiName like 'yourClassPrefix_%' ) and (QualifiedApiName like 'yourFieldPrefix_%')

SOQL to get standard objects and custom fields is:

Select EntityDefinition.QualifiedApiName, QualifiedApiName, DataType, Description  from FieldDefinition  where ( EntityDefinition.QualifiedApiName in ('Opportunity','Campaign','ContentVersion','Lead','Contact')) and QualifiedApiName like 'yourFieldPrefix_%'

Table in document listing retrieved information from SOQL can be as below:

#	Field API Name	Label Name	Field Type	Description
1	Contact	Custom Label 1	Text(30)

9. Classes

List down the classes and its description in this section. You can get list of class names and description using below SOQL.

SELECT name from ApexClass where name like 'classNamespace_%' order by name

#	Functionalities/Description	Class Name
1

10. Triggers

List down triggers created for your implementation and describe its purpose.

11. Workflows

You can use below SOQL to get list of workflows. copy paste them in table and add in their descriptions.

Select DeveloperName,Description From WorkflowAlert where DeveloperName like 'yourNamespace_%' order by developername

You can use below format to list down workflows,

Rule Name
Rule Criteria
Evaluation Criteria
Description

12. Lighting Components

List down Aura components and its purpose in this section. Below SOQL is handy to get Aura components list.

Select developername,Description from AuraDefinitionBundle where developername like 'customNamespace_%' order by developername

#	Functionality/Description	Lightning Component
1.     1

13. Process Builder/Flow

In this section list down processes and flows built for your implementation. Use below SOQL using tooling API to get list of Flows.

select DeveloperName, Description from FlowDefinition where DeveloperName like 'yourNamespace_%' order by DeveloperName 

Take screenshot of each flow and paste in the document giving numbers to each step. later you can describe each step in a table format.

eg:

#	Elements	API Name	Description
1	Screen
2	Decision
3	Screen
4	Decision

ShareX is a great free tool to capture images and editing imaging for adding steps.

https://getsharex.com/

14. Static Resources and Java-scripts

List down all static resources and javascript libraries you have used in your project in this section.

14.1 Static Resources

#	Static Resource Name	Type	Description
1.		image/png

14.2 Javascript Libraries

Location
Purpose

15. Environment Setup

In this section, you define the configuration required to do for project. Like endpoints, custom settings required.
You can define endpoint configuration in below format.

Named Credential
Label
End Point
Generate Authorization Header
Allow Merge Field in Body
Allow Merge Field in Header
Protocol
Username	[TBD]
Password	[TBD]

16. Appendix

Any additional information or references made in the document can be listed here. Example, reference to Requirement Specs or Business Documents.