mcpField
U
ub-authoring

ub-authoring

github.com/robert-hoffmannAgent 工作流2875 次安装23 周前更新
代码仓库

关于 ub-authoring

用于编写可移植技能及相关 Agent 行为规范的通用技能。它定义路由、适用边界、参考资料和验证要求,并将领域内容留在对应技能中。

主要功能

  1. 01可移植技能编写规范
  2. 02路由与不适用边界
  3. 03按需加载参考资料
  4. 04通用选择题交互指导
  5. 05输出与完成检查清单

适用场景

  1. 01设计可复用的技能结构
  2. 02改进技能描述与路由
  3. 03设定边界以避免误路由
  4. 04审查可移植的技能内容

安装

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

$npx skills add https://github.com/robert-hoffmann/uncle-bob --skill ub-authoring

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

附带文件references/authoring-conventions.md

详细介绍

UB Authoring

使命

使用此技能来制定可移植、可安装的技能及相关 Agent 行为规范的编写指南。

此技能负责可复用的编写规范,这些规范应随技能目录一起提供,而不是放在仅限仓库的文档中,或仅存在于针对特定自定义内容的技能中。

不适用场景

  • 不要使用此技能来生成端到端的自定义内容;此类任务请交由 ub-customizations 处理。
  • 如果任务是常规代码实现或框架工作,且不会更改共享的编写规范,请勿使用此技能。
  • 不要用此技能替代仓库本地的维护文档或打包元数据;这些内容应属于开发仓库,而不是可分发的技能负载。

内置规范

这些规则是此技能的基本规范,正确应用时不得依赖其他文档。

  1. 将描述视为路由元数据,而非营销文案。
  2. 如果误用技能可能造成明显代价,或误用情况很常见,请明确说明不适用场景。
  3. 优先提供具体示例和验收边界,而非含糊的告诫。
  4. 精简技能的主要内容,并将更深入的细节放入针对性参考文档。
  5. 让共享编写指南可移植到已安装的技能负载中,并避免在可复用规范中依赖仓库本地的实时信息。
  6. 将可复用的选择题交互规范保留在共享编写指南中,而不是在每个技能里重复编写相同的多选规则。

按需加载参考文档

  • 在制定共享技能结构、跨技能措辞、路由质量、可复用选择题交互规范或其他可复用编写模式时,请阅读 references/authoring-conventions.md。

核心工作流

  1. 判断任务是在更改可复用的编写规范,还是在修改单个技能的本地内容。
  2. 在此技能中保留可移植的共享指南,并将领域专属指南放在所属技能中。
  3. 仅在实际受益的更改范围内,规范描述、示例、不适用场景和共享选择题交互行为。
  4. 确保可复用参考文档可安装,并避免指向仅限仓库的文档的失效链接。

输出要求

生成非简单的编写规范更新时,请包含:

  1. routing_note
  2. boundary_note
  3. reference_note
  4. validation_note

完成检查清单

  • 共享指南在 .agents/skills/ 中仍可移植。
  • 描述措辞应体现路由逻辑,而非罗列内容。
  • 在可能发生误路由的情况下,明确说明不适用场景。
  • 如果抽象指南容易被误用,请提供具体示例。
  • 除非明确标注,否则共享参考文档不得依赖仅限仓库的假设。

评论

支持 Markdown