PranavNagrecha/AwesomeSalesforceSkills / skills/admin/data-model-documentation
data-model-documentation
VerifiedUse when a BA or admin needs to document the Salesforce data model: creating field inventories, object relationship maps, ER diagrams, or analyzing field usage across objects. Triggers: 'data dictionary', 'document our data model', 'object relationship map', 'field inventory', 'ER diagram for Salesforce'. NOT for designing the model or choosing lookup vs master-detail — use data/data-model-design-patterns. NOT for generating the Mermaid or PlantUML diagram — use architect/salesforce-erd-and-diagramming. More trigger keywords: field inventory CSV, describe API, getGlobalDescribe, DescribeFieldResult, sObject describe, schema snapshot, schema drift, blank field descriptions, undocumented fields, field ownership, data dictionary review cadence.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 23.7 KB |
| references/examples.md | markdown | 6.4 KB |
| references/gotchas.md | markdown | 15.4 KB |
| references/llm-anti-patterns.md | markdown | 7.0 KB |
| references/well-architected.md | markdown | 6.9 KB |
| references/worked-examples.md | markdown | 21.9 KB |
| scripts/check_data_model_documentation.pyexecutable | script | 16.3 KB |
| templates/data-dictionary.yaml | config | 2.0 KB |
| templates/data-model-documentation-template.md | markdown | 3.3 KB |
templates/data-dictionary.yaml
View on GitHub# Data dictionary record — fillable shape.
#
# Lint with:
# python3 ../scripts/check_data_model_documentation.py --file data-dictionary.yaml
#
# The one Account entry below is filled in so the file passes the checker as shipped and
# doubles as the format reference. Replace it; do not append to it. A worked multi-object
# version is in ../references/worked-examples.md section 5.
#
# classification -> Public | Internal | Confidential | Restricted | MissionCritical
# (the platform securityClassification value set, Metadata API CustomField)
# business_status -> Active | DeprecateCandidate | Hidden
# (the platform businessStatus value set, Metadata API CustomField)
# record_volume -> integer from SELECT COUNT() FROM <Object>, or the literal: unknown
# last_reviewed -> YYYY-MM-DD, the date a human last confirmed these rows
version: 1
generated_from:
describe_snapshot: snapshots/<date>/describe/
metadata_retrieve: snapshots/<date>/force-app/main/default/objects/
org_alias: prod
retrieved_as: <the permission profile both snapshots were taken under>
objects:
- object: Account
label: Account
type: standard
owner: owner@example.com
classification: Internal
record_volume: unknown
last_reviewed: 2026-09-04
review_cadence: quarterly
notes: >-
Standard object. Standard fields are documented from the Object Reference, not from
the retrieve — a CustomObject retrieve returns customisations only.
fields:
- api_name: Example_Field__c
label: Example Field
type: Text(255)
required: false
external_id: false
classification: Internal
owner: owner@example.com
business_status: Active
description: >-
What the field is for, what values are valid, and what breaks if it changes.
One or two sentences. An empty description is a WARN, not an error, so
in-progress dictionaries still pass while the debt stays visible.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| deprecation-and-migrationaddyosmani/agent-skillsManages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| performance-optimizationaddyosmani/agent-skillsOptimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |