#  Spec-Driven

**Repository Path**: bzsome/spec-driven

## Basic Information

- **Project Name**:  Spec-Driven
- **Description**: sdd规范模板，ai开发
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-08
- **Last Updated**: 2026-08-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SDD 规范生成项目

## 项目简介

本项目用于 **生成 SDD（Software Design Document，软件设计文档）规范**，提供一套面向开发者的精简需求设计规范模板与工作流程。

通过标准化的需求分析、概要设计、详细设计和任务清单模板，帮助团队高效推进从需求到编码的完整流程，并在每个关键阶段设置显式确认点，确保设计质量。

> **本规范为通用 SDD 规范，可任意调整。** 团队或项目可根据实际需求自定义文档模板、设计规范和编码规范，目录结构和流程均可按需裁剪。

## 项目内容

```
/workspace/
└── sdd/                          # SDD 规范核心目录
    ├── README.md                 # SDD 规范详细说明（索引导航）
    ├── 规范/                      # 规范文档目录
    │   ├── README.md              # 规范索引
    │   ├── 通用设计规范.md        # 全局设计规范（设计阶段参考，与技术无关）
    │   ├── 通用编码规范.md        # 全局编码规范（编码阶段参考）
    │   ├── 通用设计规范-激进重构类项目.md # 项目类型规范（快速迭代/激进重构类项目）
    │   ├── 通用设计规范-Java项目.md      # 技术栈规范（Java 项目）
    │   └── 通用设计规范-Vue3前端项目.md  # 技术栈规范（Vue 前端项目）
    ├── Templates/                # 文档模板库
    │   ├── 需求说明-模板.md       # 需求说明模板（必填）
    │   ├── 概要设计-模板.md       # 概要设计模板（必填）
    │   ├── 详细设计-模板.md       # 详细设计模板（选填）
    │   └── 任务清单-模板.md       # 任务清单模板（必填）
    └── 需求/                      # 需求管理目录
        └── 202607-001-示例需求/  # 单个需求示例
            ├── README.md
            ├── 01-需求说明.md
            ├── 02-概要设计.md
            ├── 03-详细设计.md
            └── 04-任务清单.md
```

## SDD 生成流程

项目采用 **精简流程 + 显式确认点** 的设计原则，标准流程如下：

```
需求说明 ──► [用户确认] ──► 概要设计 ──► [用户确认] ──► 任务清单 ──► 编码
   │             │           │             │
   │             ▼           │             ▼
   │       需求未通过        │         任务清单是
   │        则停止          │         编码的入口
   │                         │
   └─────────────────────────┴─► 详细设计（可选）
```

**关键机制**：
- 每个阶段产出文档后，必须 **显式等待用户确认** 才能进入下一阶段
- 详细设计 **不是默认产物**，仅在概要设计中明确要求时才产出
- 任务清单是所有需求的 **最终必选文档**，作为编码阶段的输入

## 文档类型说明

| 文档 | 必填/选填 | 说明 |
|------|----------|------|
| 需求说明 | **必填** | 明确"做什么"：背景、用户故事、功能需求、验收标准 |
| 概要设计 | **必填** | 明确"怎么做"：方案概述、模块划分、数据模型、接口设计 |
| 详细设计 | **选填** | 类/函数设计、关键算法、边界处理（概要阶段标注需要时使用） |
| 任务清单 | **必填** | 拆解为可执行任务，明确验收标准和工时 |

## 使用方式

1. 将 `sdd/` 目录复制到目标项目根目录
2. 在 AI 对话框中加载 `sdd/README.md` 规范文件；按项目技术栈加载对应专项规范（如 Vue 前端项目加载 `sdd/规范/通用设计规范-Vue3前端项目.md`，Java 项目加载 `sdd/规范/通用设计规范-Java项目.md`，激进重构类项目加载 `sdd/规范/通用设计规范-激进重构类项目.md`），让 AI 按规范执行需求设计、实现和验证
3. 从 `sdd/Templates/` 复制模板开始编写，按流程推进并等待确认

详细规范请查看：[sdd/README.md](file:///workspace/sdd/README.md)