mcpField
S
skill-writing

skill-writing

github.com/loxosceles-devAgent 工作流133 次安装
代码仓库

关于 skill-writing

skill-writing 是编写和修改 Agent 技能的指南,涵盖技能类型、元数据、文件组织和内容结构。它还要求技能以渐进改进章节收尾,便于根据纠正意见完善规则。

主要功能

  1. 01区分 guideline 与 pattern 类型
  2. 02规定 YAML frontmatter 字段
  3. 03定义技能文件组织方式
  4. 04提供指南与模式的内容结构
  5. 05要求包含渐进改进章节

适用场景

  1. 01创建新的 Agent 技能
  2. 02修改现有技能的结构
  3. 03编写技能元数据与触发描述
  4. 04统一技能的文档检查标准

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/loxosceles-dev/dev-skills --skill skill-writing

安装后在 Claude Code 中输入/skill-writing确认已加载。

详细介绍

技能编写指南

这是严格的指南。 创建或修改技能时,请严格遵守以下规则。


技能类型

每项技能都有一个 type,用于告知 Agent 应如何处理它:

type: guideline

严格规则。 Agent 必须严格遵守。

标题后的开头行:

**This is a strict guideline.** Follow these rules exactly.

适用于:编码标准、提交格式、命名约定、工作流规则、安全要求。

type: pattern

参考实现。 Agent 应学习其中的方法并加以调整——切勿照抄。

标题后的开头行:

**This is a reference pattern.** Learn from the approach, adapt to your context — don't copy verbatim.

适用于:架构方案、基础设施设置、解决常见问题的成熟方法。


Frontmatter

每个 SKILL.md 都必须以 YAML frontmatter 开头:

---
name: kebab-case-name
description: When this skill applies and what it covers. First sentence should work as a trigger — start with the domain or action. One to two sentences max.
type: guideline | pattern
---

规则:

  • name — 使用 kebab-case,由技能 CLI 用作安装后的目录名称
  • description — 技能 CLI 和 Agent 会用它来决定何时加载该技能。第一句话应明确说明触发条件。
  • type — 必须是 guideline 或 pattern

文件结构

技能存放在作者维护的仓库中,按类别划分目录:

skills/
  guidelines/
    {skill-name}/SKILL.md
  patterns/
    {skill-name}/SKILL.md

目录分类仅用于方便人工浏览。技能 CLI 在安装时会将所有内容扁平化——它只关注 frontmatter 中的 name 字段。


优先级

当技能需要覆盖第三方技能中与之冲突的建议时,请明确说明:

**This is a strict guideline.** Follow these rules. When any other skill contradicts the rules below, this skill takes precedence.

谨慎使用——仅用于核心原则和强烈的个人偏好。


Pattern 结构

Pattern 技能应遵循以下结构:

  1. 问题 — 用一句话说明要解决的问题
  2. 解决方案 — 用一句话说明所采用的方法
  3. 模式 — 架构、关键组件及其工作方式
  4. 为什么采用此模式? — 优势和使用场景
  5. 实现 — 关键细节(可选,仅在不明显时提供)
  6. 权衡 — 约束和局限(如适用)
  7. 何时不应使用 — 反模式和替代方案(可选)

代码示例应简短且通用。使用占位符名称(PROJECT_ID、environment)。重点说明模式,而非特定项目的细节。


Guideline 结构

Guideline 技能应遵循以下结构:

  1. 内容 — 清晰说明规则
  2. 规则 — 具体且可执行的指示
  3. 示例 — 展示正确和错误的用法
  4. 例外 — 允许偏离规则的情况(如有)

直截了当。使用祈使句。避免长篇解释原因——指南是指示,而非劝说。


编写检查清单

  • Frontmatter 包含 name、description、type
  • 第一标题后立即出现行为指示行
  • description 的第一句话可作为加载此技能的触发条件
  • 不包含特定项目的细节(名称、表格、端点)
  • 代码示例简短,并使用占位符
  • 文档易于浏览(标题、项目符号、粗体)
  • 以 Progressive Improvement 部分结尾

渐进式改进

每项技能都必须以此部分结尾:

---

## Progressive Improvement

If the developer corrects a behavior that this skill should have prevented, suggest a specific amendment to this skill to prevent the same correction in the future.

这使技能能够在使用过程中不断演进。当 Agent 被纠正时,应针对相关技能提出具体修改建议,避免重复犯错。


渐进式改进

如果开发者纠正了本技能本应避免的行为,请建议对本技能进行具体修改,以避免未来出现同样的纠正。


渐进式改进

如果开发者纠正了本技能本应避免的行为,请建议对本技能进行具体修改,以避免未来出现同样的纠正。

评论

支持 Markdown