kris/afv-library
1
0
Fork 0
mirror of https://github.com/forcedotcom/afv-library.git synced 2026-08-09 08:53:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
a25f2d4a39
afv-library/skills/creating-sf-skill/templates/skill_template.md
ysachdeva@salesforce.com a25f2d4a39 feat: integrate best practices into creating-sf-skill (Approach 2) 
Enrich the creating-sf-skill with content from the best_practices PDF:
- SKILL.md: add step 5 (read section_guide.md) + Reference File Index
- best_practices.md: add progressive disclosure architecture, extraction
  method, explain-the-why, cross-model testing principles
- progressive_disclosure.md: add scripts/ and assets/ guidance sections
- section_guide.md: new section-by-section authoring guide (frontmatter,
  TRIGGER/SKIP, tiered constraints, verification checklist)
- pr_checklist.md: new PR review checklist
- skill_template.md: add allowed-tools, TRIGGER/SKIP pattern, Clarifying
  Questions section
2026-05-05 12:40:38 +05:30

3.4 KiB
Raw Blame History

name description license metadata allowed-tools
<SKILL_NAME> <PRIMARY_PURPOSE>. TRIGGER when: <users mention METADATA_TYPE_NAMES, FILE_EXTENSIONS, or ask to ACTION_VERBS — include 5+ specific trigger phrases and implicit contexts where the user may not use the exact domain term>. SKIP when: <EXCLUSION_TRIGGERS with delegation targets>. Always use this skill for any <DOMAIN> metadata work. LICENSE.txt has complete terms
version stage related-skills author last_updated compatibility
1.0 Draft <skill1>, <skill2> <team-name> <YYYY-MM-DD> <REQUIRED_TOOLS_AND_ENVIRONMENT>
<Bash Read Write — list only the tools the skill needs>

<1-3 sentence overview: what this skill does and why it exists.>

Scope

  • In scope:
  • Out of scope: <what this skill does NOT handle — delegate to other skills>

Clarifying Questions

Before generating, confirm with the user if not already clear:

  • <Question 1 — most critical information needed>
  • <Question 2 — type or subtype selection>
  • <Question 3 — constraint-affecting detail>
  • <Question 4 — relationship or dependency info>

Required Inputs

Gather or infer before proceeding:

  • <Input 1>:
  • <Input 2>:
  • <Input 3>:

Defaults unless specified:

  • <Default 1>
  • <Default 2>

If the user provides a clear, complete request, generate immediately without unnecessary back-and-forth.

Workflow

All steps are sequential. Do not skip or reorder. If blocked, stop and ask for missing context.

  2. Read the template — load assets/<template-file> before generating.

    • For , read references/<topic>.md.

    • Compare output against examples/<example-file>.

Rules / Constraints

Constraint Rationale
<Rule 1>
<Rule 2>

Gotchas

Issue Resolution
<Problem 1>
<Problem 2>

Output Expectations

Deliverables:

  • <File 1>: <path pattern>
  • <File 2>: <path pattern>

File structure follows the template in assets/<template-file>.

Cross-Skill Integration

Need Delegate to
<Need 1> <other-skill> skill
<Need 2> <other-skill> skill

Reference File Index

File When to read
assets/<template-file> Before generating — use as the starting structure
references/<topic>.md When handling
examples/<example-file> To verify generated output matches expected format