readme-validator
验证本仓库中技能在README中的准确描述。用于验证技能文档或预提交验证时使用。
📖 中文导读:验证本仓库中技能在README中的准确描述。用于验证技能文档或预提交验证时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: readme-validator description: Validates that skills in this repository are accurately documented in the README. Use when verifying skill documentation or during pre-commit validation.
README Skill Validator
Purpose
This skill validates that the README.md accurately documents all skills in the repository.
Validation Process
When asked to validate a skill's documentation:
Read the skill's SKILL.md to understand:
- The skill's
namefrom frontmatter - The skill's
descriptionfrom frontmatter - What the skill actually does (from the body)
- The skill's
Read the README.md and find the skill's entry in the "Our Skills" section
Verify the documentation:
- The skill name must appear in the README
- The README description should accurately reflect what the skill does
- Key capabilities should be mentioned
Output format (IMPORTANT: follow exactly):
- If valid: Output only the word
VALID - If invalid: Output
INVALID:followed by a brief explanation of what needs to be fixed
- If valid: Output only the word
Examples
Valid output
VALID
Invalid output
INVALID: The README says this skill "generates reports" but the SKILL.md shows it only formats existing data.
INVALID: Skill "data-processor" is not documented in the README "Our Skills" section.