SA

sample-with-references

Uses on-demand loading of reference files to keep main documentation concise and efficient.

Install

mkdir -p .claude/skills/sample-with-references && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/5008" && unzip -o skill.zip -d .claude/skills/sample-with-references && rm skill.zip

Installs to .claude/skills/sample-with-references

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Demonstrates progressive disclosure by linking to reference files. Use this pattern when your skill has detailed content that should load on-demand.
148 chars✓ has a “when” trigger
Beginner

Key capabilities

  • Implement on-demand documentation loading
  • Modularize large API references
  • Structure documentation hierarchy
  • Optimize AI context window usage
  • Link related markdown files

How it works

Separates overview content from deep-dive references, loading supplementary files into the AI context only upon navigation or explicit request.

Inputs & outputs

You give it
Main SKILL.md file
You get back
Modular reference content loaded into context

When to use sample-with-references

  • Modularize large API documentation
  • Implement on-demand loading for tutorials
  • Structure complex project reference files

About this skill

Sample Skill with References

This skill demonstrates progressive disclosure - keeping the main SKILL.md concise while linking to detailed reference files that Claude loads only when needed.

When to Use This Pattern

Use reference files when you have:

  • Detailed API documentation
  • Multiple workflows or domains
  • Large code examples
  • Configuration references

Quick Reference

For detailed patterns and examples, see REFERENCE.md.

How It Works

  1. Startup: Only name and description load into context
  2. Triggered: Claude reads this SKILL.md (~100-200 tokens)
  3. On-demand: Claude reads REFERENCE.md only if needed

This keeps token usage low while providing comprehensive documentation.

File Organization Tips

your-skill/
├── SKILL.md           # Overview and navigation (keep under 500 lines)
├── REFERENCE.md       # Detailed reference (loaded on-demand)
├── WORKFLOWS.md       # Step-by-step guides (loaded on-demand)
└── EXAMPLES.md        # Code examples (loaded on-demand)

Best Practices

  • Keep references one level deep (don't chain REFERENCE.md → ANOTHER.md)
  • Use descriptive filenames (not doc1.md, doc2.md)
  • Add a table of contents to files over 100 lines
  • Link with relative paths: [REFERENCE.md](REFERENCE.md)

When not to use it

  • Simple, short documentation sets, Projects requiring monolithic file structures

Limitations

  • Limited to one-level deep referencing
  • Requires manual file structure maintenance

How it compares

Reduces token consumption by deferring the loading of detailed background information.

Compared to similar skills

sample-with-references side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
sample-with-references (this skill)17moNo flagsBeginner
markdown-to-html166moReviewBeginner
claude-md-enhancer19moReviewBeginner
deepinit15moReviewBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

You might also like

Search skills

Search the agent skills registry