Download to read offline
Uploaded byNaveen Gabrani
Noida User Group March 21 2025 Naveen Gabrani.pptx
Best practices related to documenting Salesforce Flows. See examples related to sample documentation, and best practices related to documenting Salesforce. Also tools related to documenting Salesforce Flows.
Noida User Group March 21 2025 Naveen Gabrani.pptx
- 1. Noida User GroupMeetup March 21, 2025 Naveen Gabrani
- 2. Best practices fordocumenting Flows Naveen Gabrani, CEO , Astrea IT Services
- 3. CEO, Astrea ITServices Naveen Gabrani
- 4. Agenda Importance of Documentation Developers/Adminshate doing documentation Documentation is a key skill A few Guidelines Change Log What to include in a Flow documentation Popular Tools
- 5. Importance of Documentation Assemblylanguage was developed in 1949 First programming language was Fortran in 1957 In last 70 years the changes in technology landscape have been astonishing What has not changed is the need for high quality documentation
- 6.
- 7. Importance of Documentation Documentationhelps you maintain your own code/flow Documentation helps your coworkers Whether you are a consultant or an org admin, you will move on to other projects Whoever takes over will thank you for the excellent documentation
- 8.
- 9.
- 10. Documentation is akey skill Comments are not Documentation Documentation is about big picture If your code breaks, you fix it Same way if your documentation breaks, then you fix it Communicating with other admins/developers what you have done, is a key skill
- 11.
- 12. A few guidelines Inthe Record Trigger Flow Name should start with Object Name, followed by purpose of the Flow In list of Flows all flows of object will appear together (if sorted by name) Use the Description fields religiously What does the Flow do Steps the Flow has to achieve its goal The objects your flow touches Where it’s invoked from Business user should be able to understand most of the description Describe inputs and outputs of Screen Flows Naming Convention Document it and make sure it is followed Use CamelCase or underscore to separate words in API names
- 13. A few guidelines PlanningPhase (For complex functionality) Before you build a flow, Salesforce recommends documenting the business process This business process can be part of your Flow Documentation Document test scenarios for the Flow Fill each description value with a meaningful description of what that particular element is used for Avoid using abbreviations in labels where possible
- 14. Flow Example Rollup summary:In account show the number of open opportunities Record-trigger Flow on Opportunity Triggered when Opportunity Stage is changed Gets the parent account Uses GetRecord to get all the child opportunities with non-closed stage for the parent Account Get the count of GetRecords Update parent Account and set the “Number of Open Opportunities” field of account
- 15.
- 16.
- 17.
- 18. Change Log For eachversion use the description to identify what change you have done in this version Alternatively use a Change Log Change Log is a document that describes all changes after a Flow/Code is deployed Capture the following Date Flow version number What was done Why was it done Reference to ticket number (if applicable)
- 19. What to includein a Flow doc Start with an overview of the Flow, including What is the goal (key requirement) of the Flow (Extremely useful for an admin taking over from you) Entry criteria: Checks that the Flow performs before processing Any complex business logic Where the Flow is invoked Test scenarios Known Limitations
- 20. What to includein a Flow doc Handling of error cases (incorrect input) Handling of boundary scenarios Describe important nodes Take a snapshot of the Node Explain its functionality Video Create a video and describe that describes how to test the functionality
- 21. Popular tools Simple Org Descriptivenames and Descriptions will suffice Word/Google Doc Flowcharting tool Miro, Lucid, Draw.io, Google Drawings Documentation tools Confluence Elements.cloud Octopus
- 23.