mcpField
W
write-a-skill

write-a-skill

github.com/dedalus-erp-pasAgent 工作流111 次安装
代码仓库

关于 write-a-skill

此 skill 指导贡献者按 foundation-skills 仓库规范创建 skill，涵盖需求收集、文件组织、文档编写与检查。

主要功能

  1. 01收集 skill 需求
  2. 02选择并核对名称
  3. 03编写精简的 SKILL.md
  4. 04添加法语文档
  5. 05检查规范与版本号

适用场景

  1. 01起草新的仓库 skill
  2. 02核对必需元数据与结构
  3. 03准备配套法语文档

安装

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

$npx skills add https://github.com/dedalus-erp-pas/foundation-skills --skill write-a-skill

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

详细介绍

编写 Skill

遵循仓库中的所有约定，为 foundation-skills 仓库创建一个新 Skill。

工作流

步骤 1：收集需求

询问用户：

  • 这个 Skill 涵盖什么任务或领域？
  • 它应处理哪些具体用例？
  • 哪些条件会触发它？（关键词、短语、文件类型）
  • 是否有需要纳入的参考资料？
步骤 2：选择 Skill 名称
  • 使用小写 kebab-case（例如，my-new-skill）
  • 名称应简短且能说明用途
  • 确认 skills/ 中尚未使用该名称
步骤 3：创建 skills/<name>/SKILL.md

从 skills/_TEMPLATE/SKILL.md 开始，但必须遵循以下约定：

Frontmatter（YAML）：

---
name: <skill-name>
description: <what it does>. Use when <triggers>.
version: 1.0.0
---
  • name、description、version 为必填项，且必须位于根级别（不能嵌套在 metadata 下）
  • description 最多 1024 个字符。第一句话说明其用途。第二句话为：“Use when [triggers].”
  • 新 Skill 的 version 从 1.0.0 开始
  • SKILL.md 使用英文编写

正文规则：

  • SKILL.md 少于 100 行——只包含简洁、可执行的说明
  • 使用渐进式披露：将详细内容放入 reference/ 文件
  • 包含具体示例
  • 不包含时效性信息
  • 如果 Skill 需要外部 CLI 工具（例如 gh、glab、jq、playwright），添加 ## Prerequisites 章节，列出每个工具及其安装命令。如果 skills/setup/reference/setup.sh 尚未处理该工具，则将其添加到该文件中，并提升 setup 的版本（setup 脚本由人工维护）。
步骤 4：创建参考文件（如有需要）

如果内容超过 100 行，或涉及不同领域，请拆分为：

skills/<name>/
├── SKILL.md
└── reference/
    ├── detailed-guide.md
    └── examples.md

在 SKILL.md 中引用：See [detailed guide](reference/detailed-guide.md)

步骤 5：创建 docs/<name>.md

创建对应的文档文件，使用法语编写。必须包含：

  • 标题（Skill 名称）
  • Description 章节
  • Cas d'usage（用例）
  • Declenchement（触发条件）
  • Fonctionnement（工作方式）
  • Exemples（英文和法文示例）
  • 版本号

样式请参考 docs/ 中的现有文件。

步骤 6：审核清单
  • skills/<name>/SKILL.md 存在，且包含有效的 frontmatter（name、description、version 位于根级别）
  • 描述包含触发条件（“Use when...”）
  • 描述少于 1024 个字符
  • SKILL.md 少于 100 行
  • SKILL.md 使用英文编写
  • docs/<name>.md 存在，且使用法语编写
  • 不包含时效性信息，术语保持一致
  • 包含具体示例
  • 参考文件仅嵌套一层
  • 如果需要外部 CLI 工具，则包含带有安装命令的 ## Prerequisites 章节
  • 如果 Skill 需要 setup.sh 尚未处理的新 CLI 工具，则将其添加到 skills/setup/reference/setup.sh，并提升 setup 的版本

版本规则

修改现有 Skill 时，提升其 version 字段：

  • patch（1.0.0 -> 1.0.1）：修正拼写、改进措辞、进行细微澄清
  • minor（1.0.0 -> 1.1.0）：添加功能、新增章节、进行有意义的行为变更
  • major（1.0.0 -> 2.0.0）：进行破坏性变更（重命名 Skill、移除功能、重构工作流）

重要说明

  • 每个 Skill 都位于 skills/<name>/SKILL.md；文档位于 docs/<name>.md（使用法语编写）
  • description 字段是 Agent 在选择要加载的 Skill 时唯一可见的内容——务必认真撰写
  • 不建议使用脚本；优先采用 Markdown 说明。仅针对确定性操作添加脚本

评论

支持 Markdown