refactor-skill-structure
关于
This skill refactors overly long or poorly structured SKILL.md files by extracting examples to a separate file, splitting compound procedures, and reorganizing content. Use it when a skill exceeds the 500-line limit, when code blocks dominate, or when procedure steps contain multiple unrelated operations. It helps maintain clean, progressively disclosed documentation that adheres to CI constraints.
快速安装
Claude Code
推荐npx skills add pjt222/agent-almanac -a claude-code/plugin add https://github.com/pjt222/agent-almanacgit clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/refactor-skill-structure在 Claude Code 中复制并粘贴此命令以安装该技能
技能文档
重構技
過長或結構亂之 SKILL.md 重構:移例至 references/EXAMPLES.md、分複合步、序章以漸示。
用
- 技超 CI 五百行限
- 一步含多無關業
- 碼塊過十五行據主體可移
- 技積臨時段、破六段標構
- 容更後過行限
- 技審報結構患非容質患
入
- 必:欲重構 SKILL.md 之路
- 可:目標行數(默八成五百限、約四百)
- 可:建
references/EXAMPLES.md乎(默是、若有可移容) - 可:分多技乎(默否、先移)
行
一:量行、識膨源
讀技、按段建行算以識膨。
# Total line count
wc -l < skills/<skill-name>/SKILL.md
# Line count per section (approximate)
grep -n "^## \|^### " skills/<skill-name>/SKILL.md
膨類:
- 可移:碼塊 >15 行、全配例、多異例
- 可分:複合步(行二+無關業)
- 可裁:餘述、過繁脈句
- 構:臨段非六標
得:行算示何段過大、何膨類用之。最大段為主重構標。
敗:技未 500 行、無顯構患→此技或不需。先驗重構請有據再行。
二:碼塊移至 references/EXAMPLES.md
塊 >15 行→移至 references/EXAMPLES.md、留簡內聯片(3-10 行)於主 SKILL.md。
-
建 references 錄:
mkdir -p skills/<skill-name>/references/ -
各可移塊:
- 全塊複至
references/EXAMPLES.md描述標下 - 主 SKILL.md 之塊代以簡 3-5 行片
- 加交引:
See [EXAMPLES.md](references/EXAMPLES.md#heading) for the complete configuration.
- 全塊複至
-
references/EXAMPLES.md構以明標:# Examples ## Example 1: Full Configuration Complete configuration file for [context]: \```yaml # ... full config here ... \``` ## Example 2: Multi-Variant Setup ### Variant A: Development \```yaml # ... dev config ... \``` ### Variant B: Production \```yaml # ... prod config ... \```
得:諸 >15 行塊已移。主 SKILL.md 留簡內聯片以易讀。交引指所移容。references/EXAMPLES.md 構良、有描述標。
敗:移碼塊不足減行(仍 >500)→步三分步。技少碼塊(如自然語技)→專注步三四。
三:複合步分
識行多無關業之步、分之。
複合號:
- 步題含「and」(如「設庫並設快取」)
- 步有多 Expected/On failure 塊(或應有)
- 步 >30 行
- 步可略或子部可異序
各複合步:
- 識內諸異業
- 各業建新
### Step N: - 後諸步重編
- 各新步有獨 Expected 與 On failure 塊
- 加新步間過脈
得:各步行一事。無步 >30 行。步數或增、各步可獨驗。
敗:分步致過細(如總 20+)→宜聚相關微步於一步含編號子步。甜點 5-12 步。
四:自 SKILL.md 加交引至所移容
確主 SKILL.md 移後仍易讀可發。
各移:
- 主 SKILL.md 內聯片於常情自足
- 交引述更多容可得
- 用相對路:
[EXAMPLES.md](references/EXAMPLES.md#section-anchor)
交引模:
- 簡片後:
See [EXAMPLES.md](references/EXAMPLES.md#full-configuration) for the complete configuration with all options. - 多異例:
See [EXAMPLES.md](references/EXAMPLES.md#variants) for development, staging, and production variants. - 延排錯:
See [EXAMPLES.md](references/EXAMPLES.md#troubleshooting) for additional error scenarios.
得:各移有應交引。讀者可循主 SKILL.md 應常情、入 references 求詳。
敗:交引致文流尷→聚多引於步末一註:For extended examples including [X], [Y], and [Z], see [EXAMPLES.md](references/EXAMPLES.md).
五:重構後驗行
諸變後重量 SKILL.md 行。
# Check main SKILL.md
lines=$(wc -l < skills/<skill-name>/SKILL.md)
[ "$lines" -le 500 ] && echo "SKILL.md: OK ($lines lines)" || echo "SKILL.md: STILL OVER ($lines lines)"
# Check references file if created
if [ -f skills/<skill-name>/references/EXAMPLES.md ]; then
ref_lines=$(wc -l < skills/<skill-name>/references/EXAMPLES.md)
echo "EXAMPLES.md: $ref_lines lines"
fi
# Total content
echo "Total content: $((lines + ${ref_lines:-0})) lines"
得:SKILL.md <500 行。理 <400 留後增地。references/EXAMPLES.md 無行限。
敗:移分後仍 >500→宜分為二技。一技覆過廣為範蔓號。用 create-skill 建第二技、二者皆更 Related Skills 交引。
六:驗諸段仍存
重構後、驗技仍有諸必段、首端完。
行 review-skill-format 單:
- YAML 首端正析
- 六必段皆存(When to Use、Inputs、Procedure、Validation、Common Pitfalls、Related Skills)
- 各步有 Expected 與 On failure 塊
- 無孤交引(諸鏈解)
# Quick section check
for section in "## When to Use" "## Inputs" "## Procedure" "## Common Pitfalls" "## Related Skills"; do
grep -q "$section" skills/<skill-name>/SKILL.md && echo "$section: OK" || echo "$section: MISSING"
done
grep -qE "## Validation( Checklist)?" skills/<skill-name>/SKILL.md && echo "Validation: OK" || echo "Validation: MISSING"
得:諸段皆存。移時無容誤刪。SKILL.md 之交引解至 EXAMPLES.md 真標。
敗:段誤刪→自 git 史復:git diff skills/<skill-name>/SKILL.md 視變。交引斷→驗 EXAMPLES.md 標錨合 SKILL.md 鏈(GitHub 風 markdown 錨律:小寫、空為連、去標點)。
驗
- SKILL.md 行 ≤ 500
- 諸碼塊 ≤ 15 行
- 移容於
references/EXAMPLES.md含描述標 - 各移於主 SKILL.md 有交引
- 無複合步餘(各步行一事)
- 重構後六必段皆存
- 各步有 Expected: 與 On failure: 塊
- YAML 首端完可析
- 交引鏈解至 EXAMPLES.md 真標
-
review-skill-format過於重構後之技
忌
- 過移:諸碼皆移使主不可讀。常情留 3-10 行片內聯。唯 >15 行或多異變者乃移
- 錨鏈斷:GitHub 風 markdown 錨於某渲染區大小寫敏。EXAMPLES.md 用小寫標、交引中正合。
grep -c "heading-text" references/EXAMPLES.md測 - 分時失 Expected/On failure:分複合步時、各新步必有自之 Expected 與 On failure 塊。分後易遺
- 過細:分應生 5-12 步。若 15+ →分過。聚微步回邏輯組
- 忘更 EXAMPLES.md 標:EXAMPLES.md 改名段、SKILL.md 諸交引錨皆需更。grep 舊錨名以捕諸引
參
review-skill-format— 重構後行格驗確技仍合update-skill-content— 容更常為構重構之觸、其推技過行限create-skill— 決如何組移容時參標構evolve-skill— 技需分為二技時、用演建衍
GitHub 仓库
相关推荐技能
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是理想选择。
