nbl-skill-constructor

技能开发环境创建器

此技能根据用户的初始需求，在指定目录中搭建完整的 skill 目录结构，并完成初步的功能实现，让用户可以在 workspace 中直接测试和开发新 skill。

重要说明

这是开发工具，不是安装工具。 此技能仅在 workspace 创建 skill 目录结构，供用户进行开发和调试。不会执行任何安装操作。

安装流程是独立的： 当用户确认 skill 开发完成并准备安装时，需要主动发起安装请求（例如："帮我打包并安装这个 skill"）。此时 agent 才会执行打包和安装操作。

关于技能

技能是模块化的、自包含的软件包，通过提供专业技能、工作流程和工具来扩展 Claude 的能力。可以将它们视为特定领域或任务的"入职指南"——它们将 Claude 从通用代理转变为配备程序性知识的专业化代理，这是任何模型都无法完全具备的。

技能为用户提供什么

1. 专业工作流程 - 特定领域的多步骤程序
2. 工具集成 - 使用特定文件格式或 API 的说明
3. 领域专业知识 - 公司特定的知识、架构、业务逻辑
4. 捆绑资源 - 用于复杂和重复任务的脚本、参考资料和资源文件

核心原则

简洁是关键

上下文窗口是公共资源。技能与 Claude 需要的其他内容共享上下文窗口：系统提示词、对话历史、其他技能的元数据以及实际的用户请求。

默认假设：Claude 已经非常智能。 只添加 Claude 尚未具备的上下文。质疑每一条信息："Claude 真的需要这个解释吗？"以及"这一段证明其 token 成本是合理的吗？"

优先使用简洁的示例而不是冗长的解释。

设置适当的自由度

将特异性级别与任务的脆弱性和变异性相匹配：

高自由度（基于文本的说明）：当多种方法都有效、决策取决于上下文或启发式方法指导时使用。

中等自由度（带参数的伪代码或脚本）：当存在首选模式、允许某些变化或配置影响行为时使用。

低自由度（特定脚本，极少参数）：当操作脆弱且容易出错、一致性至关重要或必须遵循特定序列时使用。

将 Claude 视为在探索路径：有悬崖的狭窄桥梁需要特定的护栏（低自由度），而旷野允许许多路线（高自由度）。

技能的结构

每个技能都包含一个必需的 SKILL.md 文件和可选的捆绑资源：

skill-name/
├── SKILL.md (必需)
│   ├── YAML frontmatter 元数据 (必需)
│   │   ├── name: (必需)
│   │   └── description: (必需)
│   └── Markdown 说明 (必需)
└── 捆绑资源 (可选)
    ├── scripts/          - 可执行代码 (Python/Bash/等)
    ├── references/       - 旨在按需加载到上下文中的文档
    └── assets/           - 输出中使用的文件（模板、图标、字体等）

SKILL.md (必需)

每个 SKILL.md 包含：

• Frontmatter (YAML)：包含 name 和 description 字段。这些是 Claude 读取以确定何时使用该技能的唯一字段，因此在描述技能是什么以及何时应使用它时，清晰和全面非常重要。
• 正文 (Markdown)：使用该技能的说明和指导。仅在技能触发后加载（如果有）。

捆绑资源 (可选)

脚本 (scripts/)

用于需要确定性可靠性或重复重写的任务的可执行代码（Python/Bash/等）。

脚本复杂度决策树：

选择适当的脚本方案取决于任务的复杂度：

1. 简单任务 - 系统 Python3 或 Bash 即可满足

   • 适用场景：
     • 仅需标准库（如 os, json, re, pathlib）
     • 或使用 Bash 脚本即可完成的任务
     • 无需第三方依赖
   • 实现方式：
     • 直接编写 Python3/Bash 脚本放在 scripts/ 目录
     • 使用 shebang #!/usr/bin/env python3 或 #!/bin/bash
     • Claude 直接调用：python3 scripts/your_script.py
   • 示例：文件格式转换、简单的数据处理、系统命令封装

2. 中等复杂度 - 需要第三方依赖但工程规模小

   • 适用场景：
     • 需要导入复杂的环境包（如 pandas, requests, pillow）
     • 整体工程不大（1-3 个脚本内可完成）
     • 不需要复杂的项目结构
   • 实现方式：
     • 在 scripts/ 目录下使用 uv 创建 Python 项目
     • 在 scripts/pyproject.toml 中定义依赖
     • 在 scripts/ 目录下直接放置脚本文件
     • 使用 uv run --project scripts/ python scripts/main.py 执行
     • 不要使用 pip/venv 传统方式
   • 目录结构：

     skill-name/
     ├── SKILL.md
     └── scripts/
         ├── pyproject.toml      # uv 项目配置
         ├── main.py             # 主入口脚本
         └── helper.py           # 可选的其他脚本
     

   • 调用方式：从 skill 根目录执行 uv run --project scripts/ python scripts/main.py
   • 优势：依赖管理简洁，启动速度快，避免污染系统环境，Python 代码与 skill 资源分离清晰

3. 高复杂度 - 大型项目或需要 CLI 接口

   • 适用场景：
     • 工程复杂度高，需要多模块组织
     • 需要提供命令行接口（CLI）供用户直接调用
     • 需要作为独立工具安装到系统
   • 实现方式：
     • 在 scripts/ 目录下使用 uv 创建完整的 Python 项目
     • 在 scripts/pyproject.toml 中定义入口点（entry points）
     • 使用 uv tool install --editable scripts/ 安装为系统 CLI 工具
     • 在 SKILL.md 中描述 CLI 命令的使用方式
   • 目录结构：

     skill-name/
     ├── SKILL.md
     ├── scripts/
     │   ├── pyproject.toml          # 包含 [project.scripts] 入口点
     │   ├── skill_name/             # 包代码
     │   │   ├── __init__.py
     │   │   ├── __main__.py
     │   │   ├── cli.py              # CLI 入口
     │   │   ├── commands/           # 子命令模块
     │   │   ├── core/               # 核心逻辑
     │   │   └── ...                 # 其他模块
     │   └── ... 其他辅助脚本
     ├── assets/
     └── references/
     

   • 安装：uv tool install --editable scripts/
   • 调用方式：安装后直接调用 CLI 命令（如 my-skill-command --help）或 python -m skill_name
   • 优势：所有 Python 代码集中在 scripts/ 下，与 skill 的 assets/ 和 references/ 目录分离清晰

通用原则：

• 节省 token：脚本可以在不加载到上下文的情况下执行
• 确定性：代码执行比 LLM 生成更可靠
• 可维护性：脚本可能需要由 Claude 读取以进行修补或环境特定的调整

参考资料 (references/)

文档和参考资料，旨在按需加载到上下文中以告知 Claude 的过程和思考。

• 何时包含：用于 Claude 在工作时应该引用的文档
• 示例：用于财务架构的 references/finance.md、用于公司 NDA 模板的 references/mnda.md、用于公司策略的 references/policies.md、用于 API 规范的 references/api_docs.md
• 用例：数据库架构、API 文档、领域知识、公司策略、详细的工作流程指南
• 优势：保持 SKILL.md 精简，仅在 Claude 确定需要时加载
• 最佳实践：如果文件很大（>10k 字），请在 SKILL.md 中包含 grep 搜索模式
• 避免重复：信息应该存在于 SKILL.md 或参考资料文件中，而不是两者中。对于详细信息，首选参考资料文件，除非它对技能真正核心——这保持了 SKILL.md 的精简，同时使信息可在不占用上下文窗口的情况下被发现。仅在 SKILL.md 中保留基本的过程性说明和工作流程指导；将详细的参考资料、架构和示例移动到参考资料文件中。

资源 (assets/)

不打算加载到上下文中的文件，而是在 Claude 产生的输出中使用。

• 何时包含：当技能需要将在最终输出中使用的文件时
• 示例：用于品牌资源的 assets/logo.png、用于 PowerPoint 模板的 assets/slides.pptx、用于 HTML/React 样板的 assets/frontend-template/、用于排版的 assets/font.ttf
• 用例：模板、图像、图标、样板代码、字体、被复制或修改的示例文档
• 优势：将输出资源与文档分离，使 Claude 能够在不将文件加载到上下文的情况下使用它们

技能中不应包含的内容

技能应仅包含直接支持其功能的基本文件。不要创建多余的文档或辅助文件，包括：

• README.md
• INSTALLATION_GUIDE.md
• QUICK_REFERENCE.md
• CHANGELOG.md
• 等等

技能应仅包含 AI 代理完成手头工作所需的信息。它不应包含有关创建它的过程的辅助上下文、设置和测试程序、面向用户的文档等。创建额外的文档文件只会增加混乱和混淆。

渐进式披露设计原则

技能使用三级加载系统来高效管理上下文：

1. 元数据（name + description） - 始终在上下文中（约 100 字）
2. SKILL.md 正文 - 当技能触发时（<5k 字）
3. 捆绑资源 - 根据 Claude 需要（无限制，因为脚本可以在不读入上下文窗口的情况下执行）

渐进式披露模式

保持 SKILL.md 正文为基本内容，并控制在 500 行以内，以最小化上下文膨胀。在接近此限制时，将内容拆分为单独的文件。将内容拆分到其他文件时，从 SKILL.md 引用它们并清楚地描述何时读取它们非常重要，以确保技能的读者知道它们的存在以及何时使用它们。

关键原则：当技能支持多个变体、框架或选项时，仅在 SKILL.md 中保留核心工作流程和选择指导。将变体特定的细节（模式、示例、配置）移动到单独的参考资料文件中。

模式 1：高级指南与参考资料

# PDF 处理

## 快速开始

使用 pdfplumber 提取文本：
[代码示例]

## 高级功能

- **表单填充**：有关完整指南，请参阅 [FORMS.md](FORMS.md)
- **API 参考**：有关所有方法，请参阅 [REFERENCE.md](REFERENCE.md)
- **示例**：有关常见模式，请参阅 [EXAMPLES.md](EXAMPLES.md)

Claude 仅在需要时加载 FORMS.md、REFERENCE.md 或 EXAMPLES.md。

模式 2：特定领域的组织

对于具有多个领域的技能，按领域组织内容以避免加载不相关的上下文：

bigquery-skill/
├── SKILL.md (概览和导航)
└── reference/
    ├── finance.md (收入、计费指标)
    ├── sales.md (机会、管道)
    ├── product.md (API 使用、功能)
    └── marketing.md (活动、归因)

当用户询问销售指标时，Claude 仅读取 sales.md。

同样，对于支持多个框架或变体的技能，按变体组织：

cloud-deploy/
├── SKILL.md (工作流程 + 提供商选择)
└── references/
    ├── aws.md (AWS 部署模式)
    ├── gcp.md (GCP 部署模式)
    └── azure.md (Azure 部署模式)

当用户选择 AWS 时，Claude 仅读取 aws.md。

模式 3：条件细节

显示基本内容，链接到高级内容：

# DOCX 处理

## 创建文档

使用 docx-js 创建新文档。请参阅 [DOCX-JS.md](DOCX-JS.md)。

## 编辑文档

对于简单的编辑，直接修改 XML。

**对于修订**：请参阅 [REDLINING.md](REDLINING.md)
**对于 OOXML 细节**：请参阅 [OOXML.md](OOXML.md)

Claude 仅在用户需要这些功能时读取 REDLINING.md 或 OOXML.md。

重要指南：

• 避免深度嵌套的参考资料 - 保持参考资料与 SKILL.md 相隔一级。所有参考资料文件都应从 SKILL.md 直接链接。
• 结构化较长的参考资料文件 - 对于超过 100 行的文件，在顶部包含目录，以便 Claude 在预览时可以看到完整范围。

技能开发工作流程

技能开发分为两个阶段：

阶段一：在 Workspace 中开发（本技能支持）

1. 通过具体示例了解技能
2. 规划可重用的技能内容（脚本、参考资料、资源）
3. 初始化技能目录结构
4. 编辑技能（实现资源并编写 SKILL.md）
5. 在 workspace 中调试和测试

阶段二：打包和安装（用户主动发起）

当用户确认 skill 开发完成并准备安装时，需要主动发起安装请求。此时 agent 会执行：

6. 打包技能（运行 package_skill.py）
7. 根据实际使用进行迭代

重要： 步骤 3-5 由本技能支持。步骤 6-7 需要用户主动发起安装请求后执行。

按顺序遵循这些步骤，仅在有明显不适用理由时跳过。

第一步：通过具体示例了解技能

仅当技能的使用模式已经清楚理解时才跳过此步骤。即使使用现有技能，它仍然有价值。

要创建有效的技能，清楚地了解如何使用该技能的具体示例。这种理解可以来自直接的用户示例或经过用户反馈验证的生成的示例。

例如，在构建 image-editor 技能时，相关问题包括：

• "image-editor 技能应该支持什么功能？编辑、旋转，还是其他？"
• "你能给出一些如何使用这个技能的示例吗？"
• "我可以想象用户会要求'去除这张图片的红眼'或'旋转这张图片'。还有其他你想象这个技能的使用方式吗？"
• "用户应该说些什么来触发这个技能？"

为了避免让用户不知所措，不要在一条消息中问太多问题。从最重要的问题开始，根据需要跟进以提高效果。

当对技能应支持的功能有清晰认识时，结束此步骤。

第二步：规划可重用的技能内容

要将具体示例转换为有效技能，通过以下方式分析每个示例：

1. 考虑如何从头开始执行该示例
2. 确定在重复执行这些工作流程时哪些脚本、参考资料和资源会有帮助

示例：在构建 pdf-editor 技能来处理"帮我也旋转这个 PDF"等查询时，分析显示：

1. 旋转 PDF 每次都需要重写相同的代码
2. 在技能中存储 scripts/rotate_pdf.py 脚本会有帮助

示例：在设计 frontend-webapp-builder 技能来处理"为我构建一个 todo 应用"或"为我构建一个仪表板来跟踪我的步骤"等查询时，分析显示：

1. 编写前端 Web 应用每次都需要相同的样板 HTML/React
2. 在技能中存储包含样板 HTML/React 项目文件的 assets/hello-world/ 模板会有帮助

示例：在构建 big-query 技能来处理"今天有多少用户登录了？"等查询时，分析显示：

1. 查询 BigQuery 每次都需要重新发现表架构和关系
2. 在技能中存储记录表架构的 references/schema.md 文件会有帮助

要建立技能的内容，分析每个具体示例以创建要包含的可重用资源列表：脚本、参考资料和资源。

第三步：初始化技能目录结构

此时，是时候在当前 workspace 中创建技能开发环境了。

仅当正在开发的技能已经存在并且需要迭代时才跳过此步骤。在这种情况下，继续下一步。

从头开始创建新技能时，始终运行 init_skill.py 脚本。该脚本会在当前 workspace 中创建一个新的技能目录结构，供开发和调试使用。

重要： 此脚本仅在 workspace 创建目录结构，不会执行任何安装操作。

用法：

scripts/init_skill.py <skill-name> --path <output-directory>

如果不指定 --path 参数，脚本会在当前目录下创建技能目录。

该脚本：

• 在 workspace 中创建技能目录
• 生成具有适当 frontmatter 和 TODO 占位符的 SKILL.md 模板
• 创建示例资源目录：scripts/、references/ 和 assets/
• 在每个目录中添加可以自定义或删除的示例文件

初始化后，根据需要自定义或删除生成的 SKILL.md 和示例文件。开发者可以在 workspace 中对技能进行调试和测试。

第四步：编辑技能

在编辑（新生成的或现有的）技能时，请记住该技能是为另一个 Claude 实例使用而创建的。包含对 Claude 有益且非显而易见的信息。考虑什么程序性知识、领域特定细节或可重用资产将帮助另一个 Claude 实例更有效地执行这些任务。

学习经过验证的设计模式

根据技能需求查阅这些有用的指南：

• 多步骤过程：请参阅 references/workflows.md 了解顺序工作流和条件逻辑
• 特定输出格式或质量标准：请参阅 references/output-patterns.md 了解模板和示例模式

这些文件包含有效技能设计的既定最佳实践。

从可重用的技能内容开始

要开始实现，从上面确定的可重用资源开始：scripts/、references/ 和 assets/ 文件。请注意，此步骤可能需要用户输入。例如，在实现 brand-guidelines 技能时，用户可能需要提供品牌资源或模板以存储在 assets/ 中，或文档以存储在 references/ 中。

添加的脚本必须通过实际运行来测试，以确保没有错误并且输出符合预期。如果有许多类似的脚本，只需要测试代表性样本，以确保在平衡完成时间的同时有信心让它们都能工作。

技能不需要的任何示例文件和目录都应删除。初始化脚本在 scripts/、references/ 和 assets/ 中创建示例文件以演示结构，但大多数技能不需要所有这些文件。

更新 SKILL.md

写作指南：始终使用命令式/不定式形式。

Frontmatter

使用 name 和 description 编写 YAML frontmatter：

• name：技能名称
• description：这是您技能的主要触发机制，帮助 Claude 理解何时使用该技能。
  • 包含技能的功能以及使用它的特定触发器/上下文。
  • 在此处包含所有"何时使用"的信息 - 不在正文中。正文仅在触发后加载，因此正文中的"何时使用此技能"部分对 Claude 没有帮助。
  • docx 技能的描述示例："全面的文档创建、编辑和分析，支持修订、注释、格式保留和文本提取。当 Claude 需要处理专业文档（.docx 文件）时使用：(1) 创建新文档，(2) 修改或编辑内容，(3) 处理修订，(4) 添加注释，或任何其他文档任务"

不要在 YAML frontmatter 中包含任何其他字段。

正文

编写使用该技能及其捆绑资源的说明。

第六步：打包和安装（用户主动发起）

当用户在 workspace 中完成 skill 开发并确认可以部署后，需要主动发起安装请求。用户应该明确说明：

• "帮我打包并安装这个 skill"
• "将这个 skill 打包成 .skill 文件"
• "部署这个 skill 到系统"

此时，agent 才会执行打包操作。打包过程会自动验证技能以确保它满足所有要求：

scripts/package_skill.py <path/to/skill-folder>

可选的输出目录规范：

scripts/package_skill.py <path/to/skill-folder> ./dist

打包脚本将：

1. 自动验证技能，检查：

   • YAML frontmatter 格式和必填字段
   • 技能命名约定和目录结构
   • 描述完整性和质量
   • 文件组织和资源引用

2. 如果验证通过，打包技能，创建名为技能的 .skill 文件（例如 my-skill.skill），该文件包含所有文件并保持适当的目录结构以进行分发。.skill 文件是一个带有 .skill 扩展名的 zip 文件。

如果验证失败，脚本将报告错误并退出而不创建包。修复任何验证错误并再次运行打包命令。

第七步：迭代

在测试或部署技能后，用户可能请求改进。这通常发生在使用该技能之后，对该技能如何执行有全新的上下文。

迭代工作流程：

1. 在实际任务上使用该技能
2. 注意困难或低效率
3. 在 workspace 中确定 SKILL.md 或捆绑资源应如何更新
4. 实施更改并再次在 workspace 中测试
5. 用户确认后主动发起打包和安装请求

与安装工具的区别

方面	nbl-skill-constructor	安装工具
目的	在 workspace 创建开发环境	将 skill 打包并安装到系统
触发时机	用户请求创建新 skill 开发环境	用户主动发起安装请求
创建位置	workspace 目录	系统技能目录
执行安装	不执行	执行验证和安装
调试能力	支持 workspace 调试	安装后不能直接调试