spec-flow

# Spec-Flow - Structured Development Workflow

Structured workflow for complex feature development. Creates living documentation that guides implementation and serves as team reference.

## Core Principles

1. **One phase at a time** — NEVER generate documents for subsequent phases in advance
2. **Mandatory confirmation** — After each phase, STOP and wait for user confirmation
3. **User-driven progression** — Only proceed when user says "continue"/"ok"/"next"/"继续"/"好"

## Parameters

| 参数 | 说明 |
|------|------|
| `--fast` | 跳过逐阶段确认，一次性生成所有文档（最后整体确认） |
| `--skip-design` | 跳过 Design 阶段（简单功能，架构显而易见时） |

## Language Rule

**所有生成的 .md 文件必须使用中文。**

## Interaction Rules

Load `references/interaction-rules.md` for detailed confirmation templates and prohibited behaviors.

---

## Five-Phase Workflow

Copy this checklist and check off items as you complete them:

### Spec-Flow Progress:

- [ ] **Phase 0: Initialize** ⚠️ REQUIRED
  - [ ] 0.1 Run `scripts/init-spec-flow.sh <feature-name>` or create `.spec-flow/active/<feature>/`
  - [ ] 0.2 Check if `.spec-flow/steering/` exists — if so, read for project context
  - [ ] 0.3 问自己：**这个功能的核心价值是什么？用一句话能说清吗？**

- [ ] **Phase 1: Proposal** ⚠️ REQUIRED
  - [ ] 1.1 Create `.spec-flow/active/<feature>/proposal.md` using `templates/proposal.md.template`
  - [ ] 1.2 包含：Background, Goals, Non-Goals, Scope, Risks, Open Questions
  - [ ] 1.3 问自己：**有没有隐含的需求没写出来？**
  - [ ] 1.4 问自己：**Non-Goals 是否足够明确？能防止 scope creep 吗？**
  - [ ] 1.5 ⏸️ 确认节点 — 等待用户确认后继续

- [ ] **Phase 2: Requirements**
  - [ ] 2.1 Create `.spec-flow/active/<feature>/requirements.md` using `templates/requirements.md.template`
  - [ ] 2.2 Load `references/ears-format.md` — 使用 EARS 格式编写需求
  - [ ] 2.3 包含：FR-xxx 功能需求, NFR-xxx 非功能需求, AC-xxx 验收标准
  - [ ] 2.4 问自己：**每条需求都是可测试的吗？**
  - [ ] 2.5 问自己：**边界情况...

# Spec-Flow

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**Spec-driven development workflow for AI coding agents**

Spec-Flow transforms complex feature development into a guided, phase-by-phase workflow with living documentation. Works with any AI agent that supports the Skills format.

## Features

- **Phase-by-Phase Workflow**: Proposal → Requirements → Design → Tasks → Implementation
- **Interactive Confirmation**: Each phase waits for your approval before proceeding
- **Living Documentation**: Creates `.spec-flow/` directory with Markdown docs that guide implementation
- **EARS Requirements**: Industry-standard Easy Approach to Requirements Syntax
- **3 Execution Modes**: Step (default), Batch, Phase — choose your speed
- **Team Collaboration**: Git-friendly, commit specs with your project

## Installation

```bash
# Claude Code
cd ~/.claude/skills && git clone https://github.com/echoVic/spec-flow.git

# OpenClaw
cd ~/.openclaw/workspace/skills && git clone https://github.com/echoVic/spec-flow.git

# Blade
cd ~/.blade/skills && git clone https://github.com/echoVic/spec-flow.git

# Or any agent's skills directory
```

## Quick Start

Trigger with: `spec-flow`, `spec mode`, `need a plan`, `structured development`, `写个方案`, `做个规划`

```
User: spec-flow — add user authentication

AI: [Creates proposal.md] → waits for confirmation
User: continue
AI: [Creates requirements.md] → waits for confirmation
User: continue
AI: [Creates design.md] → waits for confirmation
User: continue
AI: [Creates tasks.md] → waits for confirmation
User: execute all tasks
AI: [Implements everything]
```

Parameters: `--fast` (skip confirmations), `--skip-design` (simple features)

## Five-Phase Workflow

```
┌──────────┐    ┌──────────────┐    ┌────────┐    ┌───────┐    ┌────────────────┐
│ Proposal │ → │ Requirements │ → │ Design │ → │ Tasks │ → │ Implementation │
└──────────┘    └──────────────┘    └────────┘    └─────...