# dev-flow

**Repository Path**: code-power_1/dev-flow

## Basic Information

- **Project Name**: dev-flow
- **Description**: Dev-Flow 是一个 Trae IDE Skill，提供从需求梳理到代码交付的全流程结构化开发工作流。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: skill

## README

# Dev-Flow: 结构化软件开发工作流 Skill

## 功能介绍

Dev-Flow 是一个 Trae IDE Skill，提供从需求梳理到代码交付的全流程结构化开发工作流。

**核心特性**：

- **7 阶段工作流**：自动引导 → 需求梳理 → 契约设计 → 开发代码 → 代码审查 → 测试修复 → 代码审查（复查）→ 交付代码
- **严格质量门禁**：每个阶段设定质量门禁，未通过时回退上一阶段继续优化
- **项目规模适配**：兼容小型快速开发和中大型系统开发，自动调整执行深度
- **开发模式兼容**：支持初次开发和增量功能开发
- **AI 缺陷检查**：专门检查幻觉缺陷、边界逻辑缺陷、上下文断层缺陷
- **框架参考**：内置 Django、Flask、FastAPI、Spring Boot、Vue、React 项目结构说明
- **测试修复循环**：测试修复后必须再次代码审查，形成"测试修复 → 代码审查"循环直至通过

## 目录结构

```
dev-flow/
├── SKILL.md                          # Skill 主文件（工作流编排与触发定义）
├── README.md                         # 本文件
├── agents/                           # 各阶段执行指引
│   ├── auto-guide.md                 # 自动引导：确定项目规模、技术选型
│   ├── requirements.md               # 需求梳理：头脑风暴、需求文档输出
│   ├── contract-design.md            # 契约设计：OpenAPI 规范 API 契约
│   ├── code-development.md           # 开发代码：代码质量标准与编码风格
│   ├── code-review.md                # 代码审查：功能、安全、性能、AI 缺陷
│   ├── test-fix.md                   # 测试修复：静态检查、安全扫描、单元测试
│   └── delivery.md                   # 交付代码：运行确认、git 版本管理
└── template/                         # 框架项目结构参考
    ├── django.md                     # Django 项目结构与约定
    ├── flask.md                      # Flask 项目结构与约定
    ├── fastapi.md                    # FastAPI 项目结构与约定
    ├── springboot.md                 # Spring Boot 项目结构与约定
    ├── vue.md                        # Vue 3 项目结构与约定
    └── react.md                      # React 项目结构与约定
```

## 工作流概览

```
自动引导 → 需求梳理 → 契约设计 → 开发代码 → 代码审查 → 测试修复 → 代码审查 → 交付代码
   ↓          ↓          ↓          ↓          ↓          ↓          ↓
 质量门禁   质量门禁   质量门禁   质量门禁   质量门禁   质量门禁   质量门禁
                                                                ↓
                                                          未通过则回退
                                                         测试修复阶段
```

| 阶段 | 说明 | 质量门禁 |
|------|------|---------|
| 自动引导 | 确定项目规模、原型设计、技术选型 | 项目规模、技术选型明确，用户确认方案 |
| 需求梳理 | 头脑风暴深入了解功能和设计需求 | 需求文档完整，无歧义项，用户确认需求 |
| 契约设计 | 遵循 OpenAPI 规范设计 API 契约 | 契约文件符合规范，接口覆盖所有需求 |
| 开发代码 | 按质量标准实现代码 | 代码编译无错误，核心功能实现，风格一致 |
| 代码审查 | 审查功能、安全、性能和 AI 缺陷 | 无严重/高危问题，所有审查项通过 |
| 测试修复 | 静态检查、安全扫描、单元测试、循环修复 | 所有测试通过，无高危漏洞，项目正常运行 |
| 代码审查（复查） | 审查修复是否引入新问题 | 无严重/高危问题（未通过则回退测试修复） |
| 交付代码 | 确认运行正常，git 版本管理 | 项目可正常启动运行，交付物完整 |

## 使用方法

### 安装 Skill

1. 将 `dev-flow` 目录打包为 zip 文件（见下方打包说明）
2. 在 Trae IDE 中安装该 Skill

> **打包注意**：以下文件不属于 Skill 功能文件，打包时请勿包含：
> - `dev-flow-doc.md`（原始需求文档）
> - `test-conversation-record.md`（测试对话记录）

正确的打包命令：

```bash
# 在 dev-flow 的上级目录执行
# Windows PowerShell
Compress-Archive -Path dev-flow/SKILL.md, dev-flow/README.md, dev-flow/agents, dev-flow/template -DestinationPath dev-flow.zip

# macOS / Linux
zip dev-flow.zip -r dev-flow/SKILL.md dev-flow/README.md dev-flow/agents dev-flow/template
```

### 触发方式

当你在 Trae IDE 中提到以下内容时，Skill 会自动触发：

- "开发流程"、"开发工作流"、"从需求到交付"
- "项目开发"、"功能开发"、"dev-flow"
- 需要系统性地完成一个软件开发任务

### 执行流程

Skill 触发后，AI 会按以下流程引导你完成开发：

1. **自动引导** — 询问项目规模、原型设计、技术选型
2. **需求梳理** — 通过对话深入了解需求，输出需求文档
3. **契约设计** — 设计 API 契约（小型项目可简化）
4. **开发代码** — 按框架参考和代码质量标准实现
5. **代码审查** — 全面审查功能、安全、性能
6. **测试修复** — 运行检查、扫描、测试，循环修复
7. **代码审查（复查）** — 确认修复未引入新问题
8. **交付代码** — 确认运行正常，git 版本管理

每个阶段完成后需通过质量门禁，未通过则回退优化。

### 项目规模适配

**小型项目**：需求梳理和契约设计可合并简化，代码审查聚焦核心功能和安全，测试聚焦核心路径。

**中大型项目**：每个阶段严格按规范执行，契约设计遵循 OpenAPI 规范，代码审查全面覆盖，测试要求完整覆盖。

## Git 版本管理

### 分支命名规范

| 前缀 | 用途 | 示例 |
|------|------|------|
| `feature/` | 新功能 | `feature/user-auth` |
| `fix/` | Bug 修复 | `fix/login-error` |
| `refactor/` | 重构 | `refactor/api-layer` |
| `hotfix/` | 紧急修复 | `hotfix/security-patch` |

### 提交信息规范

```
<type>: <description>

type: feat | fix | refactor | docs | test | chore
```

### 增量功能开发流程

```bash
git checkout main
git checkout -b feature/xxx
# ... 开发 ...
git checkout main
git merge feature/xxx
git branch -d feature/xxx
```