Agent skill · Documentation

agent-documenting-references

Standardized reference documentation section structure for agents - project guidance, conventions, related agents, and Skills. Use when implementing or updating agent documentation.

majiayu000github.com/majiayu000GitHub ↗
claude-codeMIT
Install
npx skills add majiayu000/claude-skill-registry --skill agent-documenting-references-19c4f77e --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 2
SKILL.md size: 9 KB
Bundled scripts: none
Path: skills/agent/agent-documenting-references-19c4f77e/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 534
Language: HTML

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

# Documenting Agent References Standard structure for "Reference Documentation" sections in agent files to ensure consistent navigation and discoverability. ## When This Skill Loads This Skill auto-loads when implementing agents or updating agent documentation sections. ## Reference Documentation Section All agents SHOULD include a "Reference Documentation" section near the end (before any appendices) with standardized subsections. ### Section Template ```markdown ## Reference Documentation **Project Guidance**: - [CLAUDE.md](../../CLAUDE.md) - Primary guidance for Claude Code - [Agent-specific convention](path/to/convention.md) - Domain-specific standards **Related Agents**: - `maker-agent` - Creates content for this domain - `checker-agent` - Validates content (upstream dependency) - `fixer-agent` - Fixes issues found by checker - `related-domain-agent` - Related functionality **Related Conventions**: - [Primary Convention](path/to/convention.md) - Main standards this agent implements - [Secondary Convention](path/to/convention.md) - Additional relevant standards **Skills**: - `primary-skill` - Main Skill for domain knowledge - `wow-assessing-criticality-confidence` - Criticality

What's inside
Steps it walks through
  1. When This Skill Loads
  2. Reference Documentation Section
  3. Section Template
  4. Subsection Details
  5. Placement in Agent Files
  6. Examples by Agent Family
  7. docs-family Agents
  8. readme-family Agents
  9. plan-family Agents
  10. Benefits of Standardization
  11. Best Practices
  12. Key Takeaways
Ships with 1 file
  • metadata.json
More from claude-skill-registry
All skills →
About this skill
What does the agent-documenting-references skill do?

Standardized reference documentation section structure for agents - project guidance, conventions, related agents, and Skills. Use when implementing or updating agent documentation.

How do I install it?

Run `npx skills add majiayu000/claude-skill-registry --skill agent-documenting-references-19c4f77e --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going