关于 swain-help
swain-help 为 swain 技能生态提供情境化指导,包括入门说明、具体问题解答和参考资料。它根据上下文选择响应模式,并在需要时指向相关文档。
主要功能
- 01提供 swain 入门引导
- 02按上下文处理问题
- 03路由至参考资料和速查表
- 04指向相关文档
- 05提供简洁回答与示例
适用场景
- 01帮助用户了解 swain 的初始设置
- 02查找命令或工件定义
- 03获取 swain 工作流操作指南
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ cristoslc/ swain --skill swain-help安装后在 Claude Code 中输入/swain-help确认已加载。
附带文件references/quick-ref.mdreferences/workflows.md
详细介绍
swain-help
为 swain 技能生态系统提供情境化帮助。
模式检测
根据上下文确定模式:
| 信号 | 模式 |
|---|---|
| 从 swain-init 第 4 阶段调用,或用户说“刚设置好 swain”/“初始化后接下来做什么” | 入门 |
| 用户提出具体问题(“如何……”“什么是……”“什么时候应该……”) | 问答 |
| 用户想要参考资料、速查表、命令或概览 | 参考 |
入门模式
简要介绍,帮助用户了解刚安装的内容,避免信息过载。根据上下文调整语气(首次开发者或经验丰富的工程师)。
展示以下内容:
欢迎使用 swain。 以下是它的工作方式:
总体概览: Swain 管理项目的文档产物(规格、史诗、ADR 等),并跟踪实现工作,确保各次会话之间的工作不会遗漏。
需要了解的三件事:
/swain是你的入口。 它会自动路由到合适的子技能。你也可以直接调用技能(/swain-design、/swain-do等)。先设计,再构建。 想要实现某项功能时,请从
/swain开始创建规格。Swain 强制执行“先计划,后编码”的工作流——实现开始前会创建跟踪任务。自动运行健康检查。
/swain-doctor会在会话开始时运行,确保路由规则已就位且.tickets/状态正常。你无需操心。常见起点:
- “我想规划一项新功能” → 创建史诗或规格
- “为 X 编写规格” → 创建 Agent 规格
- “接下来我应该做什么?” → 检查任务待办列表
- “提交一个 Bug” → 创建
type: bug的规格- “准备发布” → 版本升级 + 更新日志
需要更多帮助? 你可以询问任何关于 swain 的问题,或说
/swain help reference获取完整速查表。
然后停止。让用户提出后续问题——不要一次性倾倒所有信息。
问答模式
根据你对 swain 的了解回答用户的具体问题。如果需要的信息超出此技能涵盖的内容,请阅读相关参考资料:
| 主题 | 查阅位置 |
|---|---|
| 产物类型、阶段、关系 | references/quick-ref.md — Artifacts 部分 |
| 命令和调用方式 | references/quick-ref.md — Commands 部分 |
| 分步操作指南 | references/workflows.md |
| 产物定义和模板 | 同级技能 swain-design/references/<type>-definition.md |
| tk(工单)CLI 参考 | 同级技能 swain-do/references/tk-cheatsheet.md |
| 故障排除 | 同级技能 swain-design/references/troubleshooting.md |
回答指南:
- 简洁作答。 回答问题,不要倾倒整份参考资料。
- 在有助于说明时使用示例——“你可以说
/swain create a spec for auth token rotation”。 - 适时移交。 如果用户的问题实际上是在请求你执行某项操作(例如“如何创建规格?”后接着说“好,帮我做”),请直接通过 Skill 工具调用相关技能。说明你正在做什么:“我会将此任务交给 swain-design。”
- 承认知识盲区。 如果某项内容未涵盖,请如实说明,不要编造 swain 的功能。
参考模式
用户需要概览或速查表时,请阅读 references/quick-ref.md 并展示相关部分。如果他们想要“全部内容”,请展示完整速查参考,但要提醒内容较多。
对于工作流操作指南,请阅读 references/workflows.md。