cx-design

cx-design: 技术设计与执行契约

把中大 feature 的关键决策、接口契约和测试重点先锁住，再进入任务规划。

先阅读：

• ${CLAUDE_PLUGIN_ROOT}/core/workflow/README.md
• ${CLAUDE_PLUGIN_ROOT}/core/workflow/protocols/design.md

强制规则

所有文件读写必须使用绝对路径。 禁止使用 ../ 相对路径。先用 git rev-parse --show-toplevel 获取绝对路径。

Worktree 检测（强制）

禁止在主分支（main/master）上执行设计阶段。必须在 feature worktree 中。

执行前检测：

check_output=$(bash ${CLAUDE_PLUGIN_ROOT}/scripts/cx-worktree.sh check \
  --feature "{feature-slug}" \
  --project-root "$(git rev-parse --show-toplevel)" 2>&1) || true

如果返回 on_main=true：

• 提示用户先运行 /cx:cx-prd 创建 worktree，或手动进入已有 worktree
• 用 AskUserQuestion 列出可用 worktree 供选择
• 不要继续执行设计阶段

使用方法

/cx:cx-design {功能名}
/cx:cx-design

设计原则

• 只服务中大 feature，S 规模默认跳过
• 设计文档是执行契约，不是长篇论文
• 优先锁定 API、状态枚举、字段映射、风险点和测试重点
• Claude Code 是共享 cx core 上的 cc adapter，不能绕过租约直接覆盖其他 runner 的 feature
• 允许在用户明确确认“进入设计阶段”后，由工作流自动衔接到本 skill

核心步骤

Step 0: 定位项目级真相

PROJECT_ROOT=$(git rev-parse --show-toplevel)
CX_DOCS_DIR="$PROJECT_ROOT/开发文档/CX工作流"
FEATURE_TITLE="{功能标题}"
FEATURE_SLUG="{feature-slug}"
FEATURE_DIR="$CX_DIR/功能/$FEATURE_TITLE"
PRD_FILE="$FEATURE_DIR/需求.md"
DESIGN_FILE="$FEATURE_DIR/设计.md"

内部关联始终使用 slug，目录展示使用中文标题。

Step 1: 读取需求与现有实现

• 读取 需求.md
• 扫描相邻模块、接口约定、DTO/VO、状态枚举
• 找出可以复用的代码和必须变更的边界

Step 2: 生成执行契约

设计文档最少包含这些章节：

1. 架构边界与模块拆分
2. API 接口契约
3. 状态枚举对照表
4. VO/DTO 字段映射
5. 风险点与测试重点

Step 3: 用勾选问答确认关键契约

对这些高风险内容给用户做确认：

• 接口路径与响应结构
• 数据库或状态模型变更
• 兼容性和迁移风险

普通实现细节不需要频繁打断。

Step 4: 写入项目文档并更新状态

优先调用共享 runner：

bash ${CLAUDE_PLUGIN_ROOT}/scripts/cx-workflow-design.sh \
  --feature <feature-slug> \
  --runner cc \
  --session-id <session-id>

写入：

开发文档/CX工作流/功能/{功能标题}/设计.md

同时把 feature 状态推进到可规划阶段，例如：

{
  "slug": "feature-slug",
  "status": "planned",
  "docs": {
    "prd": "需求.md",
    "design": "设计.md"
  }
}

什么时候需要 ADR

只有在这些情况出现时，才建议进入 /cx:cx-adr：

• 明显引入新技术
• 存储或通信方案存在实质性取舍
• 重大架构调整
• 可逆成本或回退成本很高