Back to Details

spec-workflow

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

When to use this skill

何时使用此技能

Use this skill for structured development workflow when you need to:
  • Develop new features from scratch
  • Design complex architecture
  • Integrate multiple modules
  • Work on projects involving database design
  • Work on projects involving UI design
  • Ensure high-quality requirement analysis and acceptance criteria
Do NOT use for:
  • Simple bug fixes
  • Documentation updates
  • Configuration changes
  • Code refactoring (unless explicitly requested)
当你需要进行以下工作时，可使用此技能来完成结构化开发工作流：
  • 从零开始开发新功能
  • 设计复杂架构
  • 集成多个模块
  • 开展涉及数据库设计的项目
  • 开展涉及UI设计的项目
  • 确保高质量的需求分析和验收标准
请勿用于：
  • 简单bug修复
  • 文档更新
  • 配置变更
  • 代码重构（除非明确要求）

How to use this skill (for a coding agent)

如何使用此技能（针对编码Agent）

  1. Follow the workflow strictly
    • Each phase must be completed and confirmed by user before proceeding to next phase
    • Never skip phases or proceed without user confirmation
    • Use 
      interactiveDialog
      tool when clarification is needed
  2. Apply EARS requirement syntax
    • Use EARS (Easy Approach to Requirements Syntax) for requirement descriptions
    • Format: 
      While <optional precondition>, when <optional trigger>, the <system name> shall <system response>
  3. Reference UI design rules when needed
    • If requirements involve frontend pages, must strictly reference 
      rules/ui-design.mdc
    • Determine design style and color palette in requirements phase
    • Confirm design details with user before finalizing requirements
  4. Update task status
    • Keep task status updated in 
      tasks.md
      file
    • Mark tasks as completed when finished
    • Work independently and efficiently while maintaining quality
  1. 严格遵循工作流
    • 每个阶段必须完成并经用户确认后，才能进入下一阶段
    • 绝不能跳过阶段或在未获得用户确认的情况下推进
    • 需要澄清时使用
      interactiveDialog
      工具
  2. 应用EARS需求语法
    • 使用EARS（Easy Approach to Requirements Syntax，简易需求语法）撰写需求描述
    • 格式：
      While <可选前置条件>, when <可选触发条件>, the <系统名称> shall <系统响应>
  3. 必要时参考UI设计规则
    • 如果需求涉及前端页面，必须严格参考
      rules/ui-design.mdc
      规则文件
    • 在需求阶段确定设计风格和配色方案
    • 最终确定需求前与用户确认设计细节
  4. 更新任务状态
    • 在
      tasks.md
      文件中更新任务状态
    • 完成任务后标记为已完成
    • 在保证质量的前提下独立高效地工作

Spec Workflow

规范工作流

Important: You must follow these rules. Each phase must be confirmed by the user before proceeding to the next phase.
重要提示：必须遵循以下规则。每个阶段必须经用户确认后才能进入下一阶段。

Workflow Overview

工作流概述

  1. If you determine that the user's input is a new requirement, you can work independently following standard software engineering practices. Confirm with user when necessary, and can use 
    interactiveDialog
    tool to collect information.
  2. Whenever the user inputs a new requirement, to standardize requirement quality and acceptance criteria, you must first understand the problem and requirements clearly. You must confirm with the user before proceeding to the next phase.
  1. 如果你判断用户的输入是新需求，可以遵循标准软件工程实践独立开展工作。必要时与用户确认，并可使用
    interactiveDialog
    工具收集信息。
  2. 每当用户输入新需求时，为了规范需求质量和验收标准，你必须先清晰理解问题和需求。进入下一阶段前必须与用户确认。

Phase 1: Requirements Document and Acceptance Criteria Design

阶段1：需求文档与验收标准设计

First complete the requirements design using EARS (Easy Approach to Requirements Syntax) method. If you determine the requirements involve frontend pages, you must strictly reference 
rules/ui-design.mdc
rule file. Determine design style and color palette in the requirements phase. You must confirm requirement details with the user. After final confirmation, the requirements are finalized, then proceed to the next phase.
Save to 
specs/spec_name/requirements.md
. After confirming with the user, proceed to the next phase.
Reference format:
markdown
undefined
首先使用EARS方法完成需求设计。如果你判断需求涉及前端页面，必须严格参考
rules/ui-design.mdc
规则文件。在需求阶段确定设计风格和配色方案。你必须与用户确认需求细节。最终确认后，需求即定稿，然后进入下一阶段。
保存至
specs/spec_name/requirements.md
。经用户确认后，进入下一阶段。
参考格式：
markdown
undefined

Requirements Document

Requirements Document

Introduction

Introduction

Requirement description
Requirement description

Requirements

Requirements

Requirement 1 - Requirement Name

Requirement 1 - Requirement Name

User Story: User story content
User Story: User story content

Acceptance Criteria

Acceptance Criteria

  1. Use EARS syntax: While <optional precondition>, when <optional trigger>, the <system name> shall <system response>. For example: When "Mute" is selected, the laptop shall suppress all audio output.
  2. ... ...
undefined
  1. Use EARS syntax: While <optional precondition>, when <optional trigger>, the <system name> shall <system response>. For example: When "Mute" is selected, the laptop shall suppress all audio output.
  2. ... ...
undefined

Phase 2: Technical Solution Design

阶段2：技术方案设计

After completing the requirements design, based on the current technical architecture and the confirmed requirements above, design the technical solution. It should be concise but accurately describe the technical architecture (e.g., architecture, tech stack, technology selection, database/interface design, test strategy, security). Use mermaid diagrams when necessary.
Save to 
specs/spec_name/design.md
. You must confirm with the user clearly, then proceed to the next phase.
完成需求设计后，基于当前技术架构和已确认的需求，设计技术方案。方案应简洁且准确描述技术架构（例如：架构、技术栈、技术选型、数据库/接口设计、测试策略、安全性）。必要时使用mermaid图表。
保存至
specs/spec_name/design.md
。你必须与用户明确确认后，才能进入下一阶段。

Phase 3: Task Breakdown

阶段3：任务拆解

After completing the technical solution design, based on the requirements document and technical solution, break down specific tasks. You must confirm with the user clearly, then save to 
specs/spec_name/tasks.md
. After confirming with the user, proceed to the next phase and begin formal task execution. You need to update task status in a timely manner. When executing, work as independently and autonomously as possible to ensure efficiency and quality.
Task reference format:
markdown
undefined
完成技术方案设计后，基于需求文档和技术方案，拆解具体任务。你必须与用户明确确认后，保存至
specs/spec_name/tasks.md
。经用户确认后，进入下一阶段并开始正式执行任务。你需要及时更新任务状态。执行时，尽可能独立自主地工作，以确保效率和质量。
任务参考格式：
markdown
undefined

Implementation Plan

Implementation Plan

  • 1. Task Information
    • Specific things to do
    • ...
    • _Requirement: Related requirement point number
undefined
  • 1. Task Information
    • Specific things to do
    • ...
    • _Requirement: Related requirement point number
undefined

Phase 4: Task Execution

阶段4：任务执行

  • Begin formal task execution
  • Update task status in 
    tasks.md
    file in real-time
  • Work independently and autonomously
  • Ensure efficiency and quality
  • Mark tasks as completed when finished
  • 开始正式执行任务
  • 实时在
    tasks.md
    文件中更新任务状态
  • 独立自主地工作
  • 确保效率和质量
  • 完成任务后标记为已完成

Key Principles

核心原则

  1. User Confirmation Required: Each phase must be confirmed by the user before proceeding
  2. EARS Syntax: Use EARS method for requirement descriptions
  3. UI Design Integration: When requirements involve frontend pages, must reference UI design rules and determine design style in requirements phase
  4. Technical Accuracy: Technical solutions should be concise but accurate
  5. Task Tracking: Keep task status updated throughout execution
  6. Independent Execution: Work autonomously while maintaining quality
  1. 需用户确认：每个阶段必须经用户确认后才能推进
  2. EARS语法：使用EARS方法撰写需求描述
  3. UI设计集成：当需求涉及前端页面时，必须参考UI设计规则并在需求阶段确定设计风格
  4. 技术准确性：技术方案应简洁且准确
  5. 任务跟踪：在执行全程更新任务状态
  6. 独立执行：在保证质量的前提下自主工作