Version Control

Reference Documents

Definitions

Introduction

• Overview

<include a summary of context / scope that it has been implemented, when existing, create link to functional Documentation>

• Purpose of this document

<include a summary of the purpose of this document>

<Process Name> Technical Documentation

• <Process Name> Technical Solution Overview

<Include all actions performed by Users Or System that will trigger System Actions to run (Workflows, triggers, flows, assignment rules, approval processes, email notification, Account Locks, components), if the process is too complex to describe in one diagram only, you can split it by Feature, or Phase, ...

Something Similar to the screenshot below (for the Actions refer the type of solution implemented including the names, example: Action: Update Account is being done by system using Apex, For Apex implementation: include what is being done before Insert/Update after Insert/Update 

<include rationale of the technical decision, for example, we are using 2 RT, why we need a first one, and a Second One>

• Apex trigger Logic (including handlers)

<Include description of before Insert/Update, After Insert/Update, validations done at code level

Everytime the process trigger calls another trigger, just refer to the documentation of the 2nd trigger

Every time code need to refer to Custom Metadata or Custom Settings, include thsi information as Annex

• Lightning Components

<for each of the components describe according to the following points> 

• Component Diagram

<when a component is using several components, include the architecture used>

• Component Description

What is the purpose, rationale for customization instead of Standard,  explain advanced features implementation, 

• Security (Apex only)

• • Apex Sharing

• • Methods without Sharing

<List the methods that are running without sharing and describe reason why>

• • Bypasses and Custom Permissions

<by development guidelines, all validation rule needs to have the bypass, so we just say generically that all validation have it, and if for some reason we need to avoid bypass, then we need to list the validation rules without bypass, and explain reason why>

• Email Notifications (via Apex) & Email Service

Annex