WHAT WE REPORT
The set of 8 charts on documentation shows you how well understood your Salesforce Org is. By documentation we mean 4 things:
We calculate the percentage of descriptions that are filled out. Not every item in your Org can have a description, but most can. So, we think this is a good measure of the documentation of your Org - at the most basic level.
You can easily update your Object & Field descriptions in Elements (details tab in the Org Model) and the system will update the fields in Salesforce.
Help texts filled
For all fields for your custom & standard objects we look at how many fields have the help text filled in. This data is presented in 2 charts: Custom fields by objects and Objects & related items.
You can easily update your field help text in Elements (details tab in the Org Model) and the system will update the fields in Salesforce.
Process activities linked
We calculate the percentage of how many items in your Org are connected to process activities. Every node in your Org Model can be linked to many process activities which helps to understand when a given item should be used (and, if an item is not linked to any process, is it ever being used?). For our charts we calculate if a given item is connected to any process activity.
We calculate the percentage of how many items in your Org have attachments (notes, images, URLs, data tables). Every Salesforce node can be extended with additional data which helps to understand how it is being used and evaluate its usefulness. For our charts we calculate if a given item has any attachments.
Object overall percentage
For the Documentation provided for objects and related items chart we calculate a weighted documentation percentage for each object and each documentation type. This is done by adding up and applying a weighting to all the items in an object to come up with an overall percentage. It is calculated using the following algorithm:
Total points / Maximum no. of points
Total points = Number of items that have descriptions x weighted points per type of item
Maximum = Total items that can have descriptions x weighted points per type of item
- Custom Object = 10 points
- Custom Fields = 1 point
- Field Updates = 5 points
- Process Builder Workflows = 5 points
- Record Types = 5 points
- Validation Rules = 5 points
- Workflow Rules = 5 points
The following cannot have descriptions as there is no description field in setup:
- Apex Triggers
- Page Layouts
For the remaining bar charts the % is calculated binarily, i.e. we check whether an item (e.g. object) or set of items (e.g. custom fields on an object) have descriptions filled, process activities linked & attachments added.
Object descriptions by related item
At the top of the documentation section of the Salesforce Org Analytics we provide a detailed count of descriptions completed for the items related to an object:
- Custom Fields
- Field Updates
- Process Builder Workflows
- Record Types
- Validation Rules
- Workflow Rules
But also :
- Custom objects
- Permission sets
Descriptions filled status over time
How are you doing over time? This chart shows you the trends for each item and how they have changed over time.
The descriptions for every item are displayed in the "DETAILS" tab in the right panel for the item and also as a subtitle in the main panel.
ACTIONS TO TAKE
The simplest action is to start adding descriptions for every item. It doesn't need to be more than a short summary - think Twitter, not War and Peace. Just enough so that someone quickly understands the reason for the configuration.
We made it very simple - you can actually view the Salesforce description on objects & fields in Elements Org Model and update this field on the Elements side which updates it automatically in Salesforce. You can do the same for Help Text fields for all the fields. Just update it in the Org Model and it will be automatically changed in Salesforce.
The attachment links (notes, URL, data tables, images, requirements & process activities) in the "DOCUMENTATION" tab in the right panel are for more comprehensive documentation.
These are for getting the "tribal knowledge" that is in ad-hoc documents, photos of whiteboard sessions or still in people's heads, collected and linked to the Org Model tree structure. It can be updated, refined and rewritten later - getting it linked and seeing what you have is the first step.
Clicking on any bar in charts that display objects will open the Org Model on that object and you can easily start documenting that object.