Back to Details

swain-help

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- swain-model-hint: sonnet, effort: medium — default for conceptual explanations; see per-section overrides below -->
<!-- swain-model-hint: sonnet, effort: medium — default for conceptual explanations; see per-section overrides below -->

swain-help

swain-help

Contextual help for the swain skill ecosystem.
为swain技能生态系统提供上下文帮助。

Mode detection

模式检测

Determine the mode from context:
SignalMode
Invoked from swain-init Phase 4, or user says "just set up swain" / "what now after init"Onboarding
User asks a specific question ("how do I...", "what is...", "when should I...")Question
User asks for a reference, cheat sheet, commands, or overviewReference
根据上下文判断当前模式：
触发信号模式
从swain-init第4阶段调用，或用户提及“刚设置好swain”/“初始化后该做什么”入门引导
用户提出具体问题（“我该如何...”, “什么是...”, “我应该何时...”）问题解答
用户请求概览、速查表、命令列表或总览内容参考资料

Onboarding mode

入门引导模式

Present a concise orientation — help the user understand what they just installed without overwhelming them. Adapt tone to context (first-time dev vs experienced engineer).
Present this:
Welcome to swain. Here's how it works:
The big picture: Swain manages your project's documentation artifacts (specs, epics, ADRs, etc.) and tracks implementation work — so nothing falls through the cracks between sessions.
Three things to know:
  1. /swain
    is your entry point.     It routes to the right sub-skill automatically. You can also call skills directly (
    /swain-design
    , 
    /swain-do
    , etc.).
  2. Design before you build. When you want to implement something, start with 
    /swain
    to create a spec. Swain enforces a "plan before code" workflow — it creates tracked tasks before implementation begins.
  3. Health checks are automatic. 
    /swain-doctor
    runs at session start to ensure routing rules are in place and 
    .tickets/
    is healthy. You don't need to think about it.
Common starting points:
  • "I want to plan a new feature" → creates an Epic or Spec
  • "Write a spec for X" → creates an Agent Spec
  • "What should I work on next?" → checks your task backlog
  • "File a bug" → creates a Spec with 
    type: bug
  • "Let's release" → version bump + changelog
Need more? Ask me anything about swain, or say 
/swain help reference
for a full cheat sheet.
Then stop. Let the user ask follow-up questions — don't dump everything at once.
提供简洁的入门介绍——帮助用户了解他们刚安装的内容，避免信息过载。根据用户场景调整语气（比如新手开发者 vs 资深工程师）。
展示以下内容：
欢迎使用swain。 以下是它的使用方式：
核心定位： Swain管理项目的文档工件（如规格说明、史诗需求、架构决策记录等）并跟踪实现工作——确保跨会话的任务不会遗漏。
三个关键知识点：
  1. /swain
    是入口点。     它会自动路由到对应的子技能。你也可以直接调用特定技能（如
    /swain-design
    、
    /swain-do
    等）。
  2. 先设计再构建。 当你想要实现某个功能时，从
    /swain
    开始创建规格说明。Swain强制执行“先规划再编码”的工作流——在开始实现前会创建可跟踪的任务。
  3. 健康检查自动执行。 
    /swain-doctor
    会在会话启动时自动运行，确保路由规则配置正确且
    .tickets/
    目录状态正常。你无需手动操作。
常见起始场景：
  • “我想规划一个新功能” → 创建史诗需求或规格说明
  • “为X编写规格说明” → 创建Agent规格说明
  • “我接下来该做什么？” → 查看你的任务积压
  • “提交bug” → 创建类型为
    bug
    的规格说明
  • “准备发布” → 版本号升级 + 更新变更日志
需要更多帮助？ 随时询问我任何关于swain的问题，或者输入
/swain help reference
获取完整速查表。
之后停止输出，等待用户提出后续问题——不要一次性输出所有信息。

Question mode

问题解答模式

Answer the user's specific question using your knowledge of swain. If you need details beyond what's in this skill, read the relevant reference:
TopicWhere to look
Artifact types, phases, relationships
skills/swain-help/references/quick-ref.md
— Artifacts section
Commands and invocations
skills/swain-help/references/quick-ref.md
— Commands section
Step-by-step walkthroughs
skills/swain-help/references/workflows.md
Artifact definitions and templates
skills/swain-design/references/<type>-definition.md
tk (ticket) CLI reference
skills/swain-do/references/tk-cheatsheet.md
Troubleshooting
skills/swain-design/references/troubleshooting.md
Guidelines for answering:
  • Be concise. Answer the question, don't dump the entire reference.
  • Use examples when they clarify — "You'd say 
    /swain create a spec for auth token rotation
    ".
  • Hand off when appropriate. If the user's question is really a request to do something (e.g., "how do I create a spec?" followed by "ok do it"), invoke the relevant skill directly via the Skill tool. Explain what you're doing: "I'll hand this off to swain-design."
  • Admit gaps. If something isn't covered, say so rather than inventing swain features.
<!-- swain-model-hint: haiku, effort: low — reference lookups are simple file reads -->
利用你对swain的了解回答用户的具体问题。如果所需信息超出本技能范围，请查阅相关参考资料：
主题查阅位置
工件类型、阶段、关联关系
skills/swain-help/references/quick-ref.md
— 工件章节
命令与调用方式
skills/swain-help/references/quick-ref.md
— 命令章节
分步操作指南
skills/swain-help/references/workflows.md
工件定义与模板
skills/swain-design/references/<type>-definition.md
tk（工单）CLI参考
skills/swain-do/references/tk-cheatsheet.md
故障排查
skills/swain-design/references/troubleshooting.md
回答准则：
  • 简洁明了。 只回答问题，不要输出完整的参考资料内容。
  • 结合示例 辅助说明——比如“你可以输入
    /swain create a spec for auth token rotation
    ”。
  • 适时转交任务。 如果用户的问题实际上是请求执行操作（例如，“我该如何创建规格说明？”之后跟进“好的，现在创建它”），请通过Skill工具直接调用相关技能。并向用户说明：“我将把这个任务转交给swain-design处理。”
  • 如实告知信息缺口。 如果某个内容未被覆盖，请直接说明，不要虚构swain的功能。
<!-- swain-model-hint: haiku, effort: low — reference lookups are simple file reads -->

Reference mode

参考资料模式

When the user wants an overview or cheat sheet, read 
skills/swain-help/references/quick-ref.md
and present the relevant section. If they want "everything", present the full quick reference but note it's dense.
For workflow walkthroughs, read 
skills/swain-help/references/workflows.md
.
当用户需要概览或速查表时，读取
skills/swain-help/references/quick-ref.md
并展示相关章节。如果用户请求“全部内容”，则展示完整的速查表，但需提示内容较为详实。
对于工作流分步指南，请读取
skills/swain-help/references/workflows.md
。