核心用法
document-skills 是 Claude Code 生态中的元技能(meta-skill),用于将用户草稿或现有技能转化为符合官方最佳实践的标准化技能文档。用户可通过自然语言指令(如 "document a skill"、"write a skill"、"/document-skills")触发,或直接调用 /document-skills [skill-path] [source] 命令。
该技能严格遵循 SKILL.md 五段式结构:
1. Title(技能名称与简介)
2. Inputs(输入参数说明,支持 $ARGUMENTS 与 $N 占位符)
3. Output(交付物描述)
4. Process(执行步骤与规则,核心逻辑所在)
5. Reference(关联技能与文档链接)
关键特性:
- 智能 Frontmatter 配置:自动识别需用户手动触发的任务(
disable-model-invocation: true)、隐藏技能(user-invocable: false)、工具权限白名单(allowed-tools)等 - 长度管控:强制将 SKILL.md 控制在 500 行以内,长引用内容外移至
reference.md或examples/ - 多层级部署:支持项目级(
.claude/skills/)与个人级(~/.claude/skills/)技能目录,嵌套目录自动发现
显著优点
- 权威性:直接源自 Anthropic 官方 Claude Code 文档规范,代表当前技能编写的黄金标准
- 一致性:通过强制结构模板消除团队成员间的文档风格差异
- 自动化:集成参数解析(
$ARGUMENTS、${CLAUDE_SKILL_DIR}等)、动态上下文注入(pre-run shell output) - 可发现性:
description字段优化自然语言触发,提升 Claude 自动路由准确率 - 可维护性:清晰的 Input/Process/Output 分离,便于后续迭代与新人上手
潜在缺点与局限性
- 约束性强:严格的长度与结构限制可能不适合超复杂技能(需拆分多文件)
- YAML 敏感:Frontmatter 中禁止冒号等字符,需改写为 "Scope is" 等替代句式
- 无安全扫描:官方说明文件未包含权限审计、恶意代码检测等安全机制(依赖人工审核)
- 版本锁定:紧密跟随 Claude Code 官方规范演进,旧版本技能可能需手动迁移
适合人群
| 场景 | 推荐度 |
|------|--------|
| Claude Code 重度用户,需建立团队技能库 | ⭐⭐⭐⭐⭐ |
| 需要快速将内部工作流文档化为可复用技能 | ⭐⭐⭐⭐⭐ |
| 追求文档一致性、需 Code Review 标准化 | ⭐⭐⭐⭐⭐ |
| 简单一次性任务,无需长期维护 | ⭐⭐⭐☆☆ |
| 高度定制化、超出官方模板的复杂场景 | ⭐⭐☆☆☆ |
常规风险
- 权限误配:
allowed-tools配置不当可能导致 Claude 意外执行敏感操作(如Bash(rm -rf *)) - 上下文泄露:
context: fork任务需确保子代理不暴露敏感会话信息 - 注入风险:动态上下文注入功能若引用外部命令输出,需验证来源可信度
- 覆盖风险:更新现有技能时,未明确
--force或确认机制可能导致用户自定义内容丢失