SfSkills Domains Docs GitHub

Home / admin / salesforce-learning-brief

salesforce-learning-brief

Turn a verified Salesforce research packet into a concise, role-aware learning brief with clear objectives, concept sequencing, worked examples, release caveats, checks for understanding, and citations mapped to claims. Trigger keywords: teach me Salesforce, explain Salesforce concept, create learning brief, Salesforce study guide, role-based lesson. NOT for open-ended source discovery or freshness verification — use architect/salesforce-learning-research first. NOT for generating production metadata or changing an org.

Open the skill folder on GitHub


Salesforce Learning Brief

Use this skill after evidence has been gathered and classified. The brief teaches a bounded Salesforce outcome without flattening product guarantees, recommendations, org assumptions, preview features, and practitioner judgment into one authoritative voice.


Input Gate

A valid input must provide:

When evidence is missing, do not fill the lesson from memory. Route to architect/salesforce-learning-research, remain explicitly source-bounded, or return a partial brief whose unsupported sections are marked.


Brief Shape

SectionPurposeMaximum useful scope
OutcomeState what the learner can explain or do afterwardOne measurable outcome
PrerequisitesSurface concepts or access needed firstThree to five items
Mental modelGive the organizing idea that makes details coherentOne diagram/table or short explanation
Core conceptsTeach only the concepts needed for the outcomeThree to seven concepts
WorkflowShow the order of decisions or actionsFive to nine steps
Worked exampleConnect the concepts in one realistic scenarioOne end-to-end example
Boundaries and caveatsPreserve release, license, security, limit, and org contextOnly load-bearing caveats
Knowledge checkTest understanding, not recall of wordingThree to five questions
Practice taskLet the learner apply the concept safelyOne bounded exercise
SourcesMap claims to evidenceStable citations, not a link dump

Do not reproduce the entire research packet. The packet is evidence; the brief is instruction.


Role-Aware Teaching

Adjust examples and vocabulary without changing the facts.

LearnerEmphasizeAvoid
AdministratorBusiness outcome, Setup model, permissions, automation interactions, safe validationAssuming source-control or Apex fluency
DeveloperRuntime behavior, metadata/code boundary, limits, testing, debugging, deploymentTreating every problem as code-first
ArchitectAlternatives, NFRs, product boundaries, lifecycle, evidence, governanceA click-by-click tutorial with no tradeoffs
AnalystData meaning, joins, filters, security, freshness, interpretation limitsPresenting returned rows as complete business truth
Release/operationsDependency order, gates, rollback, monitoring, audit evidenceEquating deploy success with outcome success
ConsultantTarget identity, edition/package differences, handoff, client assumptionsReusing one client's org facts in another context

State the assumed level—foundation, practitioner, or advanced—and define unfamiliar terms at first use. Do not oversimplify away load-bearing Salesforce constraints.


Claim-to-Teaching Rules

Research stateHow the brief may present it
verified-factState directly with a citation and applicability qualifier where material
official-recommendationAttribute as recommended guidance, not a platform guarantee
inferenceLabel the reasoning and cite the facts it derives from
assumptionPresent only inside the stated scenario; never generalize it
unknownTeach the uncertainty and how to verify it
unsupportedOmit from the lesson or place in Do not teach as fact

Every numeric limit, lifecycle date, feature status, command option, and release-sensitive behavior requires a nearby citation. Stable conceptual explanations can share citations at the paragraph or section level when the mapping remains unambiguous.


Explain in Layers

Use a consistent learning progression:

  1. Definition — what the capability is, in official/current terminology.
  2. Purpose — which problem it solves and which problem it does not solve.
  3. Mental model — the few relationships the learner must keep straight.
  4. Decision points — what changes the correct approach.
  5. Procedure or pattern — the safe sequence to use.
  6. Example — one scenario with explicit assumptions.
  7. Failure modes — the two or three mistakes most likely to mislead this learner.
  8. Verification — how to prove the learner's interpretation or configuration.

For advanced learners, compress definitions and deepen tradeoffs, evidence, and exceptions. For beginners, reduce branching but retain safety and context.


Examples Without Fabrication

A worked example must state:

Use sample API names such as Priority_Reason__c only when clearly labeled illustrative. Never imply that a field, permission set, package, license, or org feature exists unless the evidence packet proves it.

For procedural lessons, show a dry-run, preview, scratch-org, or read-only verification path before any write. A learning brief does not authorize production mutation.


Knowledge Checks

Prefer questions that expose misconceptions:

Provide answers separately so the learner can self-test. Do not write trivia about UI label location unless the UI path is the learning outcome.


  1. Validate the packet and learner context with architect/salesforce-learning-research; preserve claim IDs and confirm role, level, outcome, time budget, and source boundary.
  2. Select and sequence concepts from mental model to decision points to application, deferring neighboring topics that do not support the outcome.
  3. Draft with claim discipline by mapping every material statement to evidence and retaining release, product, edition/license, API, org, and lifecycle qualifiers.
  4. Demonstrate transfer with one worked example, explicit assumptions, failure modes, and a safe verification path.
  5. Assess and practice with changed-constraint knowledge checks, answers, and one bounded practice task with acceptance checks and a stop condition.
  6. Expose uncertainty and validate by listing unsupported/context-dependent claims under Do not teach as fact, running the bundled checker, and reviewing that every citation supports the claim attached to it.

Completion Checklist


Output and Validation

Draft with templates/salesforce-learning-brief-template.md, then run:

python3 skills/admin/salesforce-learning-brief/scripts/check_salesforce_learning_brief.py --input path/to/learning-brief.md

The checker validates structure and citation signals; a human or independent reviewer must still confirm that each citation supports the associated claim.


See the bundled references for beginner/advanced variants, teaching gotchas, and LLM failure modes.

Dependencies

Package files