案例讲解:老项目PRD文档如何高效接入AI Coding开发流程?
一、引言:为什么老项目开发需要新流程?
在AI Coding实践中,我们发现一个普遍痛点:老项目的PRD文档往往是Word格式,内容详尽但AI无法理解和处理。
传统开发模式下,产品经理提供的Word PRD文档主要由开发人员人工阅读理解,然后转化为代码。但在AI Coding时代,这个流程遇到了挑战:
-
AI无法直接解析Word文档:AI可以读取文本,但无法从中提取结构化的字段信息 -
PRD描述缺乏技术关联:AI不知道这个需求涉及哪些现有模块、哪些API可以复用 -
验收标准不明确:AI不知道”做到什么程度算完成”
本文将详细介绍我们总结的一套老项目AI Coding标准工作流程,帮助团队将老的PRD文档高效转化为AI可理解、可执行的开发任务。
二、老项目AI Coding标准工作流程(7步SOP)
2.1 流程总览
┌─────────────────────────────────────────────────────────────────────────────┐│ 老项目AI Coding标准流程 │└─────────────────────────────────────────────────────────────────────────────┘步骤1 步骤2 步骤3 步骤4 步骤5 步骤6 步骤7▼ ▼ ▼ ▼ ▼ ▼ ▼┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐│ 项目 │ │ 代码 │ │ 文档 │ │ 规范 │ │ PRD │ │ 需求 │ │ 迭代 ││ 评估 │───▶│ 扫描 │───▶│ 重建 │───▶│ 对齐 │───▶│ 转换 │───▶│ 开发 │───▶│ 实施 ││ │ │ │ │ │ │ │ │ │ │ │ │ │└─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘│ │ │ │ │ │ │▼ ▼ ▼ ▼ ▼ ▼ ▼评估报告 分析报告 7类技术文档 对齐报告 需求确认.md 开发规范 交付文档
2.2 步骤详解
步骤1:项目评估
目标:快速了解老项目现状,评估重构范围和工作量
AI执行的操作:
-
扫描项目目录结构 -
统计代码行数、文件数 -
识别技术栈 -
识别数据库、中间件依赖 -
评估技术债务等级
输出文档:docs/项目评估报告.md
步骤2:代码扫描与分析
目标:理解代码结构,识别问题和可复用资产
AI执行的操作:
-
分析代码结构(模块划分、依赖关系) -
扫描API接口定义 -
分析数据库表结构 -
识别业务逻辑和关键函数 -
检测潜在安全和性能问题
输出文档:docs/代码分析报告.md
步骤3:文档重建
目标:基于代码自动生成完整的技术文档(这是AI理解老系统的关键)
AI执行的操作:
-
架构设计文档 – 基于代码结构生成 -
接口文档 – 基于路由和Handler生成 -
数据模型文档 – 基于数据库代码生成 -
业务流程文档 – 基于业务逻辑生成 -
部署文档 – 基于配置文件生成
输出文档(7类核心文档):
docs/├── 架构设计文档.md # 系统架构、模块划分├── 接口文档.md # API定义、参数、响应├── 数据模型文档.md # 表结构、关系├── 业务流程文档.md # 业务逻辑、状态流转├── 部署文档.md # 部署步骤、配置├── 项目概述文档.md # 项目背景、功能清单└── 依赖分析文档.md # 外部依赖、版本
步骤4:规范对齐
目标:识别老项目与资产库的差异,生成对齐方案
AI执行的操作:
-
读取资产库中的UI规范 -
读取资产库中的前端组件 -
读取资产库中的后端API规范 -
对比老项目代码与规范差异 -
生成对齐方案
输出文档:docs/规范对齐报告.md
步骤5:PRD转换(核心关键)
目标:将Word PRD文档转换为AI可理解的结构化Markdown文档
核心价值:
-
把人工写的PRD转化为AI能提取字段的结构化文档 -
明确关联到现有系统的模块和接口 -
定义清晰的验收标准
详细说明见第三章
步骤6:需求开发
目标:基于已重建的文档和新需求,进行开发
AI执行的操作(调用SDD流程):
-
读取已重建的接口文档 → 理解现有API -
读取数据模型文档 → 理解数据结构 -
读取规范对齐报告 → 知道哪些需要兼容/改造 -
读取需求确认.md → 明确开发任务 -
调用资产库复用组件 -
生成代码并测试
步骤7:迭代实施
目标:按迭代执行开发
AI执行的操作:
-
按迭代执行编码 -
编写测试用例 -
执行部署 -
更新文档 -
沉淀新资产到资产库
三、PRD转换:核心关键步骤
3.1 为什么要做PRD转换?
|
|
|
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3.2 标准模板:需求确认.md
以下是AI友好的需求确认文档标准模板:
---name: {需求名称}需求确认version: 1.0.0projectName: {项目名称}documentType: 需求确认priority: P0/P1/P2affectedModules: ["模块1", "模块2", "模块3"]updatedAt: {日期}---# {需求名称} - 需求确认## 1. 项目概述### 1.1 需求背景{需求产生的背景、业务目标}### 1.2 需求目标1. 目标12. 目标23. 目标3---## 2. 用户角色定义| 角色 | 权限说明 | 其他说明 ||------|---------|---------|| 角色A | 权限描述 | 补充说明 || 角色B | 权限描述 | 补充说明 || 角色C | 权限描述 | 补充说明 |---## 3. 功能需求清单### 3.1 核心功能| 功能点 | 功能描述 | 涉及页面 | 优先级 ||--------|---------|---------|--------|| F1 | 功能描述 | /page/path | P0 || F2 | 功能描述 | /page/path | P1 |### 3.2 详细功能说明#### F1 {功能名称}**页面结构**:- 区域1- 区域2- 区域3**交互逻辑**:- 交互1- 交互2**API需求**:1. {接口名称}GET /api/v1/xxx- query: param1, param2- 返回: { field1, field2 }---## 4. 权限矩阵### 4.1 页面权限| 页面 | 角色A | 角色B | 角色C ||------|-------|-------|-------|| 页面1 | ✅ | ✅有限制 | ❌ || 页面2 | ✅ | ✅ | ✅ |### 4.2 权限提示文案| 场景 | 角色A提示 | 角色B提示 ||------|----------|----------|| 场景1 | 提示内容 | 提示内容 |---## 5. 页面流程图```markdown用户入口 → 判断角色 →├─ 角色A → 完整功能├─ 角色B → 有限制功能└─ 角色C → 引导页面```markdown---## 6. 数据模型变更### 6.1 新增表| 表名 | 说明 | 核心字段 ||------|-----|---------|| table_name | 说明 | field1, field2, field3 |### 6.2 变更表| 表名 | 变更内容 ||------|---------|| table_name | 变更说明 |---## 7. 接口变更清单### 7.1 新增接口| 接口 | 方法 | 说明 ||------|-----|------|| /api/v1/xxx | GET/POST | 接口说明 |### 7.2 变更接口| 接口 | 变更内容 ||------|---------|| /api/v1/xxx | 变更说明 |---## 8. 验收标准### 8.1 功能验收| 功能点 | 验收条件 | 测试场景 ||--------|---------|---------|| F1 | 条件1 | 场景1 || F2 | 条件2 | 场景2 |### 8.2 非功能验收| 指标 | 要求 ||------|-----|| 页面加载时间 | < 2秒 || 接口响应时间 | < 500ms |---## 9. 依赖与风险### 9.1 依赖项| 依赖 | 说明 ||------|-----|| 依赖项1 | 说明 |### 9.2 风险| 风险 | 影响 | 应对措施 ||------|-----|---------|| 风险1 | 影响说明 | 应对措施 |---## 10. 关联文档| 文档 | 说明 ||------|-----|| 架构设计文档.md | 现有系统架构 || 接口文档.md | 现有接口定义 || 数据模型文档.md | 现有数据表结构 |
3.3 PRD转换Skill
以下是处理PRD转换的Skill定义:
---id: prd-convert-skillname: PRD需求转换description: 将非结构化的PRD文档(Word/PDF)转换为AI可理解的结构化需求确认.md文档---# PRD需求转换Skill## Skill描述将产品经理提供的Word/PDF格式PRD文档,通过AI理解后转换为标准化的Markdown格式需求确认文档。## 输入- 原始PRD文档(Word/PDF格式)- 现有项目文档(架构设计、接口文档等,可选)## 输出标准化的 `需求确认.md` 文档## 处理流程1. **文档解析**:提取Word/PDF中的文本内容2. **需求理解**:AI理解需求内容,识别功能点、角色、权限3. **结构提取**:提取关键字段(功能点、页面、接口、权限)4. **模板映射**:将提取的内容映射到标准模板5. **技术关联**:关联到现有系统的模块和接口6. **验收定义**:补充验收标准## 核心字段| 字段 | 说明 | 必填 ||------|-----|-----|| name | 需求名称 | 是 || affectedModules | 涉及模块 | 是 || 功能需求清单 | 功能点列表 | 是 || 权限矩阵 | 角色权限对照 | 是 || 接口变更清单 | 新增/变更接口 | 是 || 验收标准 | 验收条件 | 是 |## 使用示例```markdown用户:帮我把这个PRD转换成需求确认文档Skill:解析Word文档 → 提取功能点 → 生成需求确认.md
四、案例分析:监控权限调整需求接入
说明:以下案例基于真实需求文档脱敏处理后展示
4.1 原始需求概述
需求名称:监控中心权限控制优化
核心需求:
-
实现用户分级权限体系(免费用户/付费用户/大会员) -
新增监控概览、监控对象、监控动态三个功能模块 -
无权限用户引导留资转化
涉及模块:
-
监控中心模块 -
用户权限模块 -
消息推送模块
4.2 经过7步SOP处理后的结果
步骤1-4:老项目文档重建
通过代码扫描和分析,成功重建了以下文档:
-
架构设计文档.md – 明确现有监控系统架构 -
接口文档.md – 识别出现有15个监控相关API -
数据模型文档.md – 识别出8张监控相关数据表
步骤5:PRD转换结果
转换后的需求确认文档核心内容:
---name: 监控中心权限控制优化需求确认version: 1.0.0projectName: 某标讯平台documentType: 需求确认priority: P0affectedModules: ["监控中心", "用户权限", "消息推送"]---## 3. 功能需求清单### 3.1 核心功能| 功能点 | 功能描述 | 涉及页面 | 优先级 ||--------|---------|---------|--------|| F1 监控概览 | 新增监控概览页面,展示全局指标 | /monitor/overview | P0 || F2 监控对象管理 | 支持添加/取消/筛选监控对象 | /monitor/objects | P0 || F3 监控动态列表 | 展示监控动态,支持筛选 | /monitor/dynamics | P0 || F4 权限提示引导 | 无权限时展示留资引导 | 全局 | P0 || F5 推送设置适配 | 权限控制的推送消息内容调整 | /settings/push | P1 |## 4. 权限矩阵| 页面 | 免费用户 | 付费用户 | 大会员 ||------|---------|---------|--------|| 监控概览 | ✅ 有限制 | ✅ 有限制 | ✅ 完整 || 监控对象-全部 | ✅ 有限制 | ✅ 有限制 | ✅ 完整 || 监控动态 | ✅ 有限制(500条) | ✅ 有限制(5000条) | ✅ 完整 |## 7. 接口变更清单### 7.1 新增接口| 接口 | 方法 | 说明 ||------|-----|------|| /api/v1/monitor/overview | GET | 获取监控概览数据 || /api/v1/monitor/objects | POST | 添加监控对象 || /api/v1/monitor/objects/batch | POST | 批量添加监控 || /api/v1/leads | POST | 提交留资信息 |### 7.2 变更接口| 接口 | 变更内容 ||------|---------|| /api/v1/monitor/dynamics | 增加权限过滤逻辑 |
4.3 接入开发后的效果
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
五、配套Skill体系介绍
5.1 Skill总览
整个SOP流程依赖以下Skill:
|
|
|
|
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
5.2 Skill详细说明
Skill1:老项目重构与文档重建
---id: legacy-refactor-skillname: 老项目重构与文档重建description: 基于代码自动分析、文档重建和规范对齐,实现老项目的智能重构---## 功能1. **项目评估**:扫描项目代码,生成评估报告2. **代码分析**:理解代码结构,识别问题3. **文档重建**:自动生成7类技术文档4. **规范对齐**:对比资产库,生成对齐方案## 输出- 项目评估报告.md- 代码分析报告.md- 架构设计文档.md- 接口文档.md- 数据模型文档.md- 业务流程文档.md- 部署文档.md- 规范对齐报告.md
Skill2:研发资产检索复用
---id: asset-retrieval-skillname: 研发资产检索复用description: 从企业资产库检索可复用的UI规范、组件和API---## 功能1. **UI规范检索**:检索全局UI设计规范2. **组件检索**:检索可复用的前端组件3. **API检索**:检索可复用的后端接口4. **复用建议**:生成资产复用推荐方案## 输入参数- businessDomain: 业务域- developScenario: 开发场景## 输出- UI规范摘要- 推荐组件列表- 推荐API列表- 复用等级建议
Skill3:PRD需求转换
(见3.3节)
Skill4:规范驱动研发(SDD)
---id: sdd-dev-skillname: 规范驱动研发description: 全栈规范驱动开发(SDD)技能,引导用户从需求确认到发布部署的完整研发流程---## 核心流程1. 需求对齐 → 生成需求确认.md2. 架构设计 → 调用资产检索,生成架构设计.md3. 数据模型 → 生成数据模型.md4. 接口设计 → 生成接口设计.md5. 前端设计 → 生成前端设计.md6. 编码实现 → 生成代码7. 测试验证 → 生成测试报告8. 部署上线 → 生成部署文档## 关键特性- 规范先行,确认后执行- 资产库联动,优先复用- 迭代拆分,小步快跑- 文档自动生成
六、总结
6.1 核心价值
|
|
|
|---|---|
| 文档资产化 |
|
| 流程标准化 |
|
| 资产联动 |
|
| 效率提升 |
|
6.2 实施建议
-
从小项目试点:先在1-2个老项目上验证流程 -
完善资产库:积累更多可复用组件和API -
培训团队:让团队熟悉这套SOP和配套Skill -
持续优化:根据实践反馈迭代改进
6.3 关键成功因素
-
文档质量:需求确认.md的质量决定后续开发效率 -
资产库丰富度:资产库越丰富,复用率越高 -
团队协作:产品、开发、AI三方协同
相关阅读
本文基于企业AI Coding实践总结,流程和模板可根据企业实际情况调整使用。
夜雨聆风