返回技能列表

update-skill-content

pjt222
更新于 2 days ago
6 次查看
17
2
17
在 GitHub 上查看
api

关于

This skill updates an existing SKILL.md file to enhance its documentation quality and accuracy. It focuses on refining procedures, expanding common pitfalls, and synchronizing related skills, particularly when content is outdated or unclear. Use it to maintain skill documentation after API changes or based on user feedback.

快速安装

Claude Code

推荐
主要方式
npx skills add pjt222/agent-almanac -a claude-code
插件命令备选方式
/plugin add https://github.com/pjt222/agent-almanac
Git 克隆备选方式
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/update-skill-content

在 Claude Code 中复制并粘贴此命令以安装该技能

技能文档

Update Skill Content

Improve an existing SKILL.md by refining procedure steps, expanding Common Pitfalls with real failure modes, synchronizing the Related Skills section, and bumping the version number. Use this after a skill passes format validation but has content gaps, stale references, or incomplete procedures.

When to Use

  • A skill's procedure steps reference outdated tools, APIs, or version numbers
  • Common Pitfalls section is thin (fewer than 3 pitfalls) or missing real failure modes
  • Related Skills section has broken cross-references or is missing relevant links
  • Procedure steps lack concrete code examples or have vague instructions
  • A new skill has been added to the library that should be cross-referenced from existing skills
  • After receiving feedback that a skill's procedures are unclear or incomplete

Inputs

  • Required: Path to the SKILL.md file to update
  • Optional: Specific section(s) to focus on (e.g., "procedure", "pitfalls", "related-skills")
  • Optional: Source of updates (changelog, issue report, user feedback)
  • Optional: Whether to bump version (default: yes, minor bump)

Procedure

Step 1: Read Current Skill and Assess Content Quality

Read the entire SKILL.md and evaluate each section for completeness and accuracy.

Assessment criteria per section:

  • When to Use: Are triggers concrete and actionable? (3-5 items expected)
  • Inputs: Are types, defaults, and required/optional clearly separated?
  • Procedure: Does each step have concrete code, Expected, and On failure?
  • Validation: Are checklist items objectively testable? (5+ items expected)
  • Common Pitfalls: Are pitfalls specific with symptoms and fixes? (3-6 expected)
  • Related Skills: Do referenced skills exist? Are obvious related skills missing?

Got: A clear picture of which sections need improvement, with specific gaps identified.

If fail: If the skill cannot be read (path error), verify the path. If the SKILL.md has broken YAML frontmatter, fix frontmatter first using review-skill-format before attempting content updates.

Step 2: Check for Stale References

Scan procedure steps for version-specific references, tool names, URLs, and API patterns that may have changed.

Common staleness indicators:

  • Specific version numbers (e.g., v1.24, R 4.3.0, Node 18)
  • URLs that may have moved or expired
  • CLI flags or command syntax that has changed
  • Package names that have been renamed or deprecated
  • Configuration file formats that have evolved
# Check for version-specific references
grep -nE '[vV][0-9]+\.[0-9]+' skills/<skill-name>/SKILL.md

# Check for URLs
grep -nE 'https?://' skills/<skill-name>/SKILL.md

Got: A list of potentially stale references with line numbers. Each reference is verified as current or flagged for update.

If fail: If too many references to check manually, prioritize: procedure code blocks first (most likely to cause runtime failures), then Common Pitfalls (may reference old workarounds), then informational text.

Step 3: Update Procedure Steps for Accuracy

For each procedure step identified as needing improvement:

  1. Verify code blocks still execute correctly or reflect current best practices
  2. Add missing context sentences that explain why the step is needed
  3. Ensure concrete commands use real paths, real flags, and real output
  4. Update Expected blocks to match current tool behavior
  5. Update On failure blocks with current error messages and fixes

When updating code blocks, preserve the original structure:

  • Keep step numbering consistent
  • Maintain the ### Step N: Title format
  • Do not reorder steps unless the original order was incorrect

Got: All procedure steps contain current, executable code. Expected/On failure blocks reflect actual current behavior.

If fail: If unsure whether a code block is still correct, add a note: <!-- TODO: Verify this command against current version -->. Do not remove working code blocks to replace with untested alternatives.

Step 4: Expand Common Pitfalls

Review the Common Pitfalls section and expand if gaps exist.

Quality criteria for pitfalls:

  • Each pitfall has a bold name followed by a specific description
  • The description includes the symptom (what goes wrong) and the fix (how to avoid or recover)
  • Pitfalls are drawn from real failure modes, not hypothetical concerns
  • 3-6 pitfalls is the target range

Sources for new pitfalls:

  • Procedure steps with complex On failure blocks (these are likely pitfalls)
  • Related skills that warn about the same tools or patterns
  • Common issues reported by users of the procedure

Got: 3-6 pitfalls, each with a specific symptom and fix. No generic pitfalls like "be careful" or "test thoroughly".

If fail: If only 1-2 pitfalls can be identified, that is acceptable for basic-complexity skills. For intermediate and advanced skills, fewer than 3 pitfalls suggests the author has not fully explored failure modes — flag this for future expansion.

Step 5: Synchronize Related Skills Section

Verify all cross-references in the Related Skills section are valid and add any missing links.

  1. For each referenced skill, verify it exists:
    # Check if referenced skill exists
    test -d skills/referenced-skill-name && echo "EXISTS" || echo "NOT FOUND"
    
  2. Search for skills that reference this skill (they should be cross-linked):
    # Find skills that reference this skill
    grep -rl "skill-name" skills/*/SKILL.md
    
  3. Check for obvious related skills based on domain and tags
  4. Use the format: - \skill-id` — one-line description of the relationship`

Got: All referenced skills exist on disk. Bidirectional cross-references are in place. No orphaned links.

If fail: If a referenced skill does not exist, either remove the reference or note it as a planned future skill with a comment. If many skills reference this one but are not listed in Related Skills, add the most relevant 2-3.

Step 6: Bump Version in Frontmatter

Update the metadata.version field following semantic versioning:

  • Patch bump (1.0 to 1.1): Typo fixes, minor clarifications, URL updates
  • Minor bump (1.0 to 2.0): New procedure steps, significant content additions, structural changes
  • Note: Skills use simplified two-part versioning (major.minor)

Also update any date fields if present in the frontmatter.

Got: Version is bumped appropriately. The change magnitude matches the update scope.

If fail: If the current version cannot be parsed, set it to "1.1" and add a comment noting the version history gap.

Validation

  • All procedure steps contain current, executable code or concrete instructions
  • No stale version references, URLs, or deprecated tool names remain
  • Every procedure step has Expected: and On failure: blocks
  • Common Pitfalls section has 3-6 specific pitfalls with symptoms and fixes
  • All Related Skills cross-references point to existing skills
  • Bidirectional cross-references are in place for closely related skills
  • Version in frontmatter has been bumped appropriately
  • Line count remains under 500 after updates
  • SKILL.md still passes review-skill-format validation after changes

Pitfalls

  • Updating code without testing: Changing a command in a procedure step without verifying it works is worse than leaving the old command. When uncertain, add a verification comment rather than an untested replacement.
  • Over-expanding pitfalls: Adding 10+ pitfalls dilutes the section. Keep the 3-6 most impactful pitfalls; move edge cases to a references/ file if needed.
  • Breaking cross-references during updates: When renaming a skill or changing its domain, grep the entire skills library for references to the old name. Use grep -rl "old-name" skills/ to find all occurrences.
  • Forgetting to bump version: Every content update, no matter how small, should bump the version. This allows consumers to detect when a skill has changed.
  • Scope creep into refactoring: Content updates improve what the skill says. If you find yourself restructuring sections or extracting to references/, switch to the refactor-skill-structure skill instead.

Related Skills

  • review-skill-format — Run format validation before content updates to ensure the base structure is sound
  • refactor-skill-structure — When content updates push the skill over 500 lines, refactor structure to make room
  • evolve-skill — For deeper changes that go beyond content updates (e.g., creating an advanced variant)
  • create-skill — Reference the canonical format spec when adding new sections or procedure steps
  • repair-broken-references — Use for bulk cross-reference repair across the entire skills library

GitHub 仓库

pjt222/agent-almanac
路径: i18n/caveman-lite/skills/update-skill-content
0
agentsagentskillsai-assisted-developmentclaude-codeskillsteams

相关推荐技能

content-collections

Content Collections 是一个 TypeScript 优先的构建工具,可将本地 Markdown/MDX 文件转换为类型安全的数据集合。它专为构建博客、文档站和内容密集型 Vite+React 应用而设计,提供基于 Zod 的自动模式验证。该工具涵盖从 Vite 插件配置、MDX 编译到生产环境部署的完整工作流。

查看技能

polymarket

这个Claude Skill为开发者提供完整的Polymarket预测市场开发支持,涵盖API调用、交易执行和市场数据分析。关键特性包括实时WebSocket数据流,可监控实时交易、订单和市场动态。开发者可用它构建预测市场应用、实施交易策略并集成实时市场预测功能。

查看技能

creating-opencode-plugins

该Skill帮助开发者创建OpenCode插件,用于接入命令、文件、LSP等25+种事件。它提供了插件结构、事件API规范和JavaScript/TypeScript实现模式,适合需要拦截操作、扩展功能或自定义事件处理的场景。开发者可通过它快速构建响应式模块来增强OpenCode AI助手的能力。

查看技能

sglang

SGLang是一个专为LLM设计的高性能推理框架,特别适用于需要结构化输出的场景。它通过RadixAttention前缀缓存技术,在处理JSON、正则表达式、工具调用等具有重复前缀的复杂工作流时,能实现极速生成。如果你正在构建智能体或多轮对话系统,并追求远超vLLM的推理性能,SGLang是理想选择。

查看技能