The "Documentation overview" dashboard, part of the 'Documentation' section in Analytics 360, is designed to provide a comprehensive overview of the level of institutional and configuration knowledge retained by your business.
Aimed at the platform owners, this feature set offers a series of insights into the overall level of documentation in your Org. This dashboard is a powerful tool for understanding and tracking your efforts at capturing Org wisdom.
Article outline
Prerequisites
Object and child metadata by filled descriptions breakdown
As a platform owner, you'll find a donut chart that breaks down objects into 4 buckets based on the overall level of filled descriptions on the object and its child metadata.
We look at the objects themselves and its child metadata: custom fields, field updates, record types, validation rules, as well as process builders and workflow rules. We then calculate % of filled descriptions using the following algorithm:
Total points / Maximum no. of points
Total points = Number of items that have documentation x weighted points per type of item
Maximum = Total items that can have documentation x weighted points per type of item
Weighted points
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
Therefore objects that score as highly documented have descriptions filled on most of its metadata and the important metadata.
Object and child metadata by linked diagrams
Using the same calculation method as in the previous chart, we count number of metadata belonging to an object (specifically custom fields, field updates, record types, validation rules, as well as process builders and workflow rules) and see whether they are linked to business process activities.
For those who subscribe to process-driven design, this chart demonstrates what proportion of their objects are mostly or fully process-designed.
ElementsGPT descriptions filled out
As part of ElementsGPT capability, we are indexing specific metadata types for solution recommendations. But big input into making those recommendations accurate is to have filled out and good quality metadata descriptions.
For the following metadata types you can capture descriptions in Elements. The bar chart then shows what % of those metadata types have description fields filled out:
Objects
Record types
Fields
Apex classes
Apex triggers
Flows
Profiles
Permission sets
Permission set groups
Validation rules
Descriptions over time
This charts demonstrates how the the level of descriptions filled for metadata changes over time for specified types:
Permission sets
Flows
Custom objects
Custom fields
Record types
Validation rules
You might be also interested in
Documentation breakdown dashboard : breakdown of all objects in the Org based on the percentage of filled documentation