Skip to content

[Docs]: Remove extraneous README.md from plugin-structure skill #84

@sjnims

Description

@sjnims

Which documentation needs improvement?

Skill documentation

Specific Location

plugins/plugin-dev/skills/plugin-structure/README.md

What's unclear or missing?

The plugin-structure skill contains a README.md file that is not part of the official Claude Code skill structure.

Per the official docs (https://code.claude.com/docs/en/skills.md) and the skill-development skill, a skill directory should contain:

  • SKILL.md (required)
  • references/ (optional)
  • examples/ (optional)
  • scripts/ (optional)
  • assets/ (optional)

README.md is not a recognized skill component and introduces:

  1. Maintenance burden - Contains word counts (e.g., "SKILL.md (1,654 words)") that can drift from actual values
  2. Redundancy - Duplicates information already in SKILL.md header and body
  3. Non-conformance - Violates the skill specification

Suggested Improvement

Remove the README.md file entirely. The skill's structure, purpose, and trigger conditions are already documented in SKILL.md's frontmatter and body.

rm plugins/plugin-dev/skills/plugin-structure/README.md

Type of issue

  • Other (structural issue - file doesn't belong in skill structure)

Additional Context

Found during comprehensive skill review against official Claude Code documentation (skills.md and plugins-reference.md).

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions