关于 review-skill
review-skill 是用于新技能入库前审核的清单,涵盖文件结构、元数据、内容质量、凭据安全及文档更新。
主要功能
- 01必需文件与 frontmatter 检查
- 02内容规范与长度要求
- 03凭据和敏感文件检查
- 04文档同步清单
- 05技能目录审核命令
适用场景
- 01批准前审核新技能
- 02检查技能元数据与配套文件
- 03确认文档和下载包已更新
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ aviz85/ claude-skills-library --skill review-skill安装后在 Claude Code 中输入/review-skill确认已加载。
详细介绍
技能审核清单
将新技能添加到库之前,请先审核。
文件结构检查
| 必需 | 文件 | 用途 |
|---|---|---|
| ✅ | skill.md | 主要技能文件(必须小写!) |
| ⚠️ | SETUP.md | 设置指南(如果技能需要 API/配置) |
| ⚠️ | scripts/ | 辅助脚本(如有需要) |
| ⚠️ | .env.example | 示例环境文件(绝不能包含实际凭据!) |
skill.md 要求
Frontmatter(YAML 标头)
---
name: skill-name # Required: kebab-case
description: "..." # Required: trigger phrases
setup: "./SETUP.md" # If SETUP.md exists
enhancedBy: # Optional: complementary skills
- other-skill: "Benefit description. Without it: fallback behavior"
usedBy: # Optional: for helper skills
- parent-skill
---
内容指南
- 简洁 - 理想长度不超过 100 行,最多 150 行
- 聚焦工作流 - 介绍如何使用,而非如何设置
- 示例 - 提供快速命令示例
- 不包含设置说明 - 设置说明应放在 SETUP.md 中
SETUP.md 要求(如有需要)
- 分步设置指南
- API/账户创建说明
- 凭据配置(.env)
- 用于验证设置的测试命令
- 故障排除表格
文档站点同步
添加技能后,更新 docs/index.html:
- 在
skills-grid部分添加技能卡片 - 如果技能包含
enhancedBy,添加组合徽章:
<div class="skill-combo" style="...">
<span style="color: var(--green-primary);">🔗 עובד טוב יותר עם:</span>
<span style="color: var(--text-secondary);">skill-a, skill-b</span>
</div>
- 创建
docs/skills/[skill-name].html指南页面 - 创建
docs/downloads/[skill-name].zip供下载
审核清单
批准新技能之前:
-
skill.md存在(小写) - Frontmatter 包含
name和description - 如果存在 SETUP.md,则设置
setup: "./SETUP.md" - 内容少于 150 行
- 所有文件中均不包含凭据或 API 密钥
-
.gitignore包含.env和敏感文件 - 如果存在脚本,则提供
--dry-run选项 - 文档站点已更新技能卡片
- 已创建下载 ZIP 文件
质量标准
优质描述(触发短语)
# Good - tells Claude when to use
description: "Send WhatsApp messages. Use when user says 'send message', 'whatsapp', 'הודעה'."
# Bad - too vague
description: "WhatsApp integration"
优质 enhancedBy 格式
# Good - explains benefit and fallback
enhancedBy:
- get-contact: "Auto-lookup contact by name. Without it: ask user for phone directly"
# Bad - no context
enhancedBy:
- get-contact
命令
对技能文件夹运行审核:
# Check structure
ls -la skills/[skill-name]/
# Check frontmatter
head -20 skills/[skill-name]/skill.md
# Check line count
wc -l skills/[skill-name]/skill.md
评论
支持 Markdown