Agent-Skills.md

Agent Skills: speckit-checklist-zh

基于用户需求为当前功能生成定制检查清单的专业工具。专门用于需求质量验证，生成"英语的单元测试"，验证需求的完整性、清晰度和一致性。触发词：speckit-checklist、检查清单、需求验证、质量检查、checklist、requirements validation、质量审查、spec review

UncategorizedID: forztf/open-skilled-sdd/speckit-checklist-zh

Repository

forztf/open-skilled-sdd
forztf
41

Skill Files

Browse the full folder contents for speckit-checklist-zh.

Download Skill

Loading file tree…

skills/speckit-checklist-zh/SKILL.md

Skill Metadata

Name
speckit-checklist-zh
Description
基于用户需求为当前功能生成定制检查清单的专业工具。专门用于需求质量验证，生成"英语的单元测试"，验证需求的完整性、清晰度和一致性。触发词：speckit-checklist、检查清单、需求验证、质量检查、checklist、requirements validation、质量审查、spec review

检查表目的："中文的单元测试"

关键概念：检查表是要求编写的单元测试 - 它们验证特定领域中要求的质量、清晰度和完整性。

不用于验证/测试：

  • ❌ 不是"验证按钮正确点击"
  • ❌ 不是"测试错误处理是否有效"
  • ❌ 不是"确认 API 返回 200"
  • ❌ 不是检查代码/实现是否符合规格

用于要求质量验证：

  • ✅ "是否为所有卡片类型定义了视觉层次要求？"（完整性）
  • ✅ "是否用特定的尺寸/定位量化了'显著显示'？"（清晰度）
  • ✅ "所有交互元素的悬停状态要求是否一致？"（一致性）
  • ✅ "是否为键盘导航定义了可访问性要求？"（覆盖范围）
  • ✅ "规格是否定义了徽标图像加载失败时的情况？"（边缘情况）

比喻：如果您的规格是编写的代码，那么检查表就是它的单元测试套件。您正在测试要求是否编写良好、完整、明确并准备好实施 - 而不是测试实现是否有效。

用户输入

$ARGUMENTS

您必须在继续之前考虑用户输入（如果不为空）。

执行步骤

scripts: sh: .specify/scripts/bash/check-prerequisites.sh --json ps: .specify/scripts/powershell/check-prerequisites.ps1 -Json

  1. 设置：从仓库根目录运行 {SCRIPT} 并解析 JSON 以获取 FEATURE_DIR 和 AVAILABLE_DOCS 列表。

    • 所有文件路径必须是绝对的。
    • 对于参数中的单引号，如 "I'm Groot"，使用转义语法：例如 'I'''m Groot'（或者如果可能的话使用双引号："I'm Groot"）。

  2. 澄清意图（动态）：推导出最多三个初始上下文澄清问题（无预设目录）。它们必须：

    • 从用户的措辞 + 从规格/计划/任务中提取的信号生成
    • 仅询问会实质性改变检查表内容的信息
    • 如果在 $ARGUMENTS 中已经明确，则单独跳过
    • 优先考虑精确性而非广度

    生成算法：

    1. 提取信号：功能领域关键词（例如，auth, latency, UX, API），风险指标（"critical", "must", "compliance"），利益相关者提示（"QA", "review", "security team"）和明确的交付物（"a11y", "rollback", "contracts"）。
    2. 将信号聚类到候选关注领域（最多 4 个）按相关性排序。
    3. 识别可能的受众和时机（作者、审阅者、QA、发布）如果不明确。
    4. 检测缺失的维度：范围广度、深度/严谨性、风险重点、排除边界、可测量的验收标准。
    5. 从这些原型中制定问题：
      • 范围细化（例如，"这应该包括与 X 和 Y 的集成接触点还是仅限于本地模块正确性？"）
      • 风险优先级（例如，"这些潜在风险领域中哪些应该接受强制门控检查？"）
      • 深度校准（例如，"这是一个轻量级的预提交健全性列表还是正式的发布门？"）
      • 受众框架（例如，"这将仅由作者使用还是在 PR 审阅期间由同行使用？"）
      • 边界排除（例如，"我们应该明确排除本轮的性能调优项目吗？"）
      • 场景类别差距（例如，"未检测到恢复流程——回滚/部分故障路径是否在范围内？"）

    问题格式规则：

    • 如果提供选项，生成一个紧凑的表格，列：选项 | 候选 | 重要性原因
    • 限制最多 A-E 个选项；如果自由形式答案更清晰则省略表格
    • 永远不要要求用户重述他们已经说过的话
    • 避免推测性类别（无幻觉）。如果不确定，明确询问："确认 X 是否在范围内。"

    无法交互时的默认值：

    • 深度：标准
    • 受众：如果与代码相关则为审阅者（PR）；否则为作者
    • 关注：前 2 个相关性聚类

    输出问题（标记 Q1/Q2/Q3）。回答后：如果≥2 个场景类别（替代/异常/恢复/非功能性领域）仍不清楚，您可以要求最多两个更有针对性的后续问题（Q4/Q5），每个问题附带一行理由（例如，"未解决的恢复路径风险"）。不要超过五个总问题。如果用户明确拒绝更多问题则跳过升级。

  3. 理解用户请求：结合 $ARGUMENTS + 澄清答案：

    • 推导检查表主题（例如，安全、审阅、部署、用户体验）
    • 整合用户提到的明确必备项目
    • 将焦点选择映射到类别脚手架
    • 从规格/计划/任务中推断任何缺失的上下文（不要幻觉）

  4. 加载功能上下文：从 FEATURE_DIR 读取：

    • spec.md：功能要求和范围
    • plan.md（如果存在）：技术细节、依赖关系
    • tasks.md（如果存在）：实施任务

    上下文加载策略：

    • 仅加载与活跃关注领域相关的必要部分（避免完整文件转储）
    • 更喜欢将长段落总结为简洁的场景/要求要点
    • 使用渐进式披露：仅在检测到差距时添加后续检索
    • 如果源文档很大，生成中间摘要项目而不是嵌入原始文本

  5. 生成检查表 - 创建"要求的单元测试"：

    • 如果不存在则创建 FEATURE_DIR/checklists/ 目录
    • 生成唯一的检查表文件名：
      • 使用基于领域的简短描述性名称（例如，ux.md, api.md, security.md）
      • 格式：[domain].md
      • 如果文件存在，则追加到现有文件
    • 从 CHK001 开始顺序编号项目
    • 每个 speckit-checklist 运行创建一个新文件（从不覆盖现有检查表）

    核心原则 - 测试要求，而不是实现： 每个检查表项目必须评估要求本身：

    • 完整性：所有必要的要求是否存在？
    • 清晰度：要求是否明确且具体？
    • 一致性：要求是否相互对齐？
    • 可测量性：要求是否可以客观验证？
    • 覆盖范围：是否解决了所有场景/边缘情况？

    类别结构 - 按要求质量维度分组项目：

    • 要求完整性（是否记录了所有必要的要求？）
    • 要求清晰度（要求是否具体且明确？）
    • 要求一致性（要求是否对齐而无冲突？）
    • 验收标准质量（成功标准是否可测量？）
    • 场景覆盖（是否解决了所有流程/案例？）
    • 边缘情况覆盖（是否定义了边界条件？）
    • 非功能性要求（性能、安全性、可访问性等 - 是否指定？）
    • 依赖关系和假设（是否记录和验证？）
    • 歧义和冲突（需要澄清什么？）

    如何编写检查表项目 - "英语的单元测试"：

    ❌ 错误（测试实现）：

    • "验证着陆页显示 3 个剧集卡片"
    • "测试桌面端悬停状态是否有效"
    • "确认徽标点击导航到主页"

    ✅ 正确（测试要求质量）：

    • "是否明确指定了特色剧集的确切数量和布局？" [完整性]
    • "是否用特定的尺寸/定位量化了'显著显示'？" [清晰度]
    • "所有交互元素的悬停状态要求是否一致？" [一致性]
    • "是否为所有交互式 UI 定义了键盘导航要求？" [覆盖范围]
    • "当徽标图像加载失败时是否指定了回退行为？" [边缘情况]
    • "是否为异步剧集数据定义了加载状态？" [完整性]
    • "规格是否定义了竞争 UI 元素的视觉层次？" [清晰度]

    项目结构： 每个项目应遵循此模式：

    • 询问要求质量的问题格式
    • 关注规格/计划中编写（或未编写）的内容
    • 包括质量维度在括号中 [完整性/清晰度/一致性等]
    • 检查现有要求时引用规格部分 [Spec §X.Y]
    • 使用 [Gap] 标记检查缺失的要求

    按质量维度的示例：

    完整性：

    • "是否为所有 API 故障模式定义了错误处理要求？ [Gap]"
    • "是否为所有交互元素指定了可访问性要求？ [完整性]"
    • "是否为响应式布局定义了移动断点要求？ [Gap]"

    清晰度：

    • "是否用特定的时间阈值量化了'快速加载'？ [清晰度, Spec §NFR-2]"
    • "是否明确定义了'相关剧集'的选择标准？ [清晰度, Spec §FR-5]"
    • "是否用可测量的视觉属性定义了'显著'？ [歧义, Spec §FR-4]"

    一致性：

    • "所有页面的导航要求是否对齐？ [一致性, Spec §FR-10]"
    • "着陆页和详情页的卡片组件要求是否一致？ [一致性]"

    覆盖范围：

    • "是否为零状态场景（无剧集）定义了要求？ [覆盖范围, 边缘情况]"
    • "是否解决了并发用户交互场景？ [覆盖范围, Gap]"
    • "是否为部分数据加载失败指定了要求？ [覆盖范围, 异常流程]"

    可测量性：

    • "视觉层次要求是否可测量/可测试？ [验收标准, Spec §FR-1]"
    • "是否可以客观验证'平衡的视觉权重'？ [可测量性, Spec §FR-2]"

    场景分类和覆盖（要求质量重点）：

    • 检查是否存在要求：主要、替代、异常/错误、恢复、非功能性场景
    • 对于每个场景类别，询问："[场景类型] 要求是否完整、清晰且一致？"
    • 如果场景类别缺失："[场景类型] 要求是故意排除还是缺失？ [Gap]"
    • 包括状态变更时的弹性/回滚："是否为迁移失败定义了回滚要求？ [Gap]"

    可追溯性要求：

    • 最低要求：≥80% 的项目必须至少包含一个可追溯性引用
    • 每个项目应引用：规格部分 [Spec §X.Y]，或使用标记：[Gap]、[Ambiguity]、[Conflict]、[Assumption]
    • 如果不存在 ID 系统："是否建立了要求和验收标准 ID 方案？ [可追溯性]"

    表面和解决问题（要求质量问题）： 询问有关要求本身的问题：

    • 歧义："'快速' 一词是否用具体指标量化？ [歧义, Spec §NFR-1]"
    • 冲突："§FR-10 和 §FR-10a 中的导航要求是否冲突？ [冲突]"
    • 假设："'始终可用的播客 API' 假设是否已验证？ [假设]"
    • 依赖关系："是否记录了外部播客 API 要求？ [依赖关系, Gap]"
    • 缺失定义："是否用可测量的标准定义了'视觉层次'？ [Gap]"

    内容整合：

    • 软上限：如果原始候选项目 > 40，按风险/影响优先排序
    • 合并检查相同要求方面的近似重复项
    • 如果 >5 个低影响边缘情况，创建一个项目："边缘情况 X、Y、Z 是否在要求中解决？ [覆盖范围]"

    🚫 绝对禁止 - 这些使其成为实现测试，而不是要求测试：

    • ❌ 任何以"验证"、"测试"、"确认"、"检查" + 实现行为开头的项目
    • ❌ 引用代码执行、用户操作、系统行为
    • ❌ "正确显示"、"正常工作"、"按预期功能"
    • ❌ "点击"、"导航"、"渲染"、"加载"、"执行"
    • ❌ 测试用例、测试计划、QA 程序
    • ❌ 实现细节（框架、API、算法）

    ✅ 必需模式 - 这些测试要求质量：

    • ✅ "是否为 [场景] 定义/指定/记录了 [要求类型]？"
    • ✅ "是否用具体标准量化/澄清了 [模糊术语]？"
    • ✅ "[部分 A] 和 [部分 B] 的要求是否一致？"
    • ✅ "是否可以客观测量/验证 [要求]？"
    • ✅ "要求中是否解决了 [边缘情况/场景]？"
    • ✅ "规格是否定义了 [缺失方面]？"

  6. 结构参考：按照 .specify/templates/checklist-template.md 中的规范模板生成检查表，包括标题、元部分、类别标题和 ID 格式。如果模板不可用，使用：H1 标题、目的/创建的元行、包含 - [ ] CHK### <要求项目> 行的 ## 类别部分，全局递增 ID 从 CHK001 开始。

  7. 报告：输出创建的检查表的完整路径、项目计数，并提醒用户每次运行都会创建一个新文件。总结：

    • 选择的关注领域
    • 深度级别
    • 参与者/时机
    • 任何包含的用户明确指定的必备项目

重要：每个 speckit-checklist 命令调用都使用简短的描述性名称创建检查表文件，除非文件已存在。这允许：

  • 不同类型的多个检查表（例如，ux.md, test.md, security.md）
  • 简单、易记的文件名，指示检查表目的
  • 在 checklists/ 文件夹中轻松识别和导航

为避免混乱，使用描述性类型并在完成后清理过时的检查表。

示例检查表类型和示例项目

用户体验要求质量： ux.md

示例项目（测试要求，而不是实现）：

  • "是否用可测量的标准定义了视觉层次要求？ [清晰度, Spec §FR-1]"
  • "是否明确定义了 UI 元素的数量和定位？ [完整性, Spec §FR-1]"
  • "交互状态要求（悬停、焦点、活动）是否一致定义？ [一致性]"
  • "是否为所有交互元素指定了可访问性要求？ [覆盖范围, Gap]"
  • "图像加载失败时是否定义了回退行为？ [边缘情况, Gap]"
  • "是否可以客观测量'显著显示'？ [可测量性, Spec §FR-4]"

API 要求质量： api.md

示例项目：

  • "是否为所有故障场景指定了错误响应格式？ [完整性]"
  • "是否用具体阈值量化了速率限制要求？ [清晰度]"
  • "所有端点的身份验证要求是否一致？ [一致性]"
  • "是否为外部依赖关系定义了重试/超时要求？ [覆盖范围, Gap]"
  • "版本控制策略是否在要求中记录？ [Gap]"

性能要求质量： performance.md

示例项目：

  • "是否用具体指标量化了性能要求？ [清晰度]"
  • "是否为所有关键用户旅程定义了性能目标？ [覆盖范围]"
  • "是否为不同负载条件指定了性能要求？ [完整性]"
  • "是否可以客观测量性能要求？ [可测量性]"
  • "是否为高负载场景定义了降级要求？ [边缘情况, Gap]"

安全要求质量： security.md

示例项目：

  • "是否为所有受保护资源指定了身份验证要求？ [覆盖范围]"
  • "是否为敏感信息定义了数据保护要求？ [完整性]"
  • "威胁模型是否记录并与要求对齐？ [可追溯性]"
  • "安全要求是否与合规义务一致？ [一致性]"
  • "是否定义了安全故障/违规响应要求？ [Gap, 异常流程]"

反例：不要做的事情

❌ 错误 - 这些测试实现，而不是要求：

- [ ] CHK001 - 验证着陆页显示 3 个剧集卡片 [Spec §FR-001]
- [ ] CHK002 - 测试桌面端悬停状态是否正确工作 [Spec §FR-003]
- [ ] CHK003 - 确认徽标点击导航到主页 [Spec §FR-010]
- [ ] CHK004 - 检查相关剧集部分显示 3-5 个项目 [Spec §FR-005]

✅ 正确 - 这些测试要求质量：

- [ ] CHK001 - 是否明确定义了特色剧集的数量和布局？ [完整性, Spec §FR-001]
- [ ] CHK002 - 是否为所有交互元素一致定义了悬停状态要求？ [一致性, Spec §FR-003]
- [ ] CHK003 - 是否为所有可点击品牌元素明确了导航要求？ [清晰度, Spec §FR-010]
- [ ] CHK004 - 是否记录了相关剧集的选择标准？ [Gap, Spec §FR-005]
- [ ] CHK005 - 是否为异步剧集数据定义了加载状态要求？ [Gap]
- [ ] CHK006 - 是否可以客观测量"视觉层次"要求？ [可测量性, Spec §FR-001]

主要区别：

  • 错误：测试系统是否正常工作
  • 正确：测试要求是否编写正确
  • 错误：行为验证
  • 正确：要求质量验证
  • 错误："它是否做 X？"
  • 正确："X 是否明确定义？"