2026-04-20-02-53-00 - 初始化代码编纂工作流:创建工程分析目录、文档模板、经验记录,并将工作流规范写入AGENTS.md
This commit is contained in:
136
工程分析/00-工作流总览.md
Normal file
136
工程分析/00-工作流总览.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# 代码编纂工作流总览
|
||||
|
||||
> 本文档定义了所有项目修改需求的标准执行流程。
|
||||
> 每次接到修改需求后,严格按照以下 7 个步骤执行。
|
||||
|
||||
---
|
||||
|
||||
## 执行前准备
|
||||
|
||||
- 记录当前时间戳:`{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}`
|
||||
- 时间戳将作为本次需求的唯一标识,贯穿所有文档命名
|
||||
|
||||
---
|
||||
|
||||
## Step 0:记录开始时间
|
||||
|
||||
在对话开头明确记录:
|
||||
```
|
||||
[工作流开始] {Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 1:阅读工程分析
|
||||
|
||||
- 阅读 `.\工程分析\` 文件夹下所有已有文档
|
||||
- 了解项目当前状态、历史修改、已知踩坑点
|
||||
- 若文件夹为空(首次执行),则基于当前代码库做一次整体工程分析并留存
|
||||
|
||||
---
|
||||
|
||||
## Step 2:整理需求
|
||||
|
||||
- 将用户提出的修改需求整理成结构化文档
|
||||
- 写入 `.\工程分析\需求分析-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md`
|
||||
- 文档结构见 [需求分析-模板.md](./需求分析-模板.md)
|
||||
|
||||
---
|
||||
|
||||
## Step 3:制定实现方案
|
||||
|
||||
- 基于需求分析和代码理解,制定详细的实现方案
|
||||
- 写入 `.\工程分析\实现方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md`
|
||||
- 文档结构见 [实现方案-模板.md](./实现方案-模板.md)
|
||||
- **⚠️ 必须经用户二次人工审核确认后方可继续**
|
||||
|
||||
---
|
||||
|
||||
## Step 4:制定测试方案
|
||||
|
||||
- 基于实现方案,制定可执行的测试验证方案
|
||||
- 写入 `.\工程分析\测试方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md`
|
||||
- 文档结构见 [测试方案-模板.md](./测试方案-模板.md)
|
||||
- **⚠️ 必须经用户二次人工审核确认后方可继续**
|
||||
|
||||
---
|
||||
|
||||
## Step 5:执行前检查 + 经验沉淀
|
||||
|
||||
### 5.1 执行前必读
|
||||
- 阅读 `.\工程分析\经验记录.md`
|
||||
- 避免重复踩坑
|
||||
|
||||
### 5.2 执行修改
|
||||
- 严格按照已审核的实现方案执行代码修改
|
||||
- 按测试方案执行验证
|
||||
|
||||
### 5.3 执行后记录
|
||||
- 若执行过程中遇到任何问题,在 `.\工程分析\经验记录.md` 中以以下四段式追加:
|
||||
|
||||
```markdown
|
||||
## [{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}] 问题简述
|
||||
|
||||
### A. 具体问题
|
||||
(描述遇到的现象或错误)
|
||||
|
||||
### B. 产生问题原因
|
||||
(根因分析)
|
||||
|
||||
### C. 解决问题方案
|
||||
(具体的解决步骤或代码改动)
|
||||
|
||||
### D. 后续如何避免问题
|
||||
(预防措施、规范建议、检查清单项)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 6:Git 备份
|
||||
|
||||
使用 gitea 进行备份提交:
|
||||
|
||||
```bash
|
||||
# 添加所有变更(含新增的需求/方案文档)
|
||||
git add .
|
||||
|
||||
# 提交,消息格式:"{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec} - 本次修改简要描述"
|
||||
git commit -m "2026-04-20-02-46-43 - 示例:修复报告编辑器自动保存失效问题"
|
||||
|
||||
# 推送至远程主分支
|
||||
git push origin main
|
||||
```
|
||||
|
||||
- 完成后向用户报告:"已完成对文档的备份 commit"
|
||||
|
||||
---
|
||||
|
||||
## Step 7:重新部署
|
||||
|
||||
执行项目构建并部署:
|
||||
|
||||
```bash
|
||||
# 安装依赖(如 node_modules 缺失)
|
||||
npm install
|
||||
|
||||
# 类型检查
|
||||
npm run lint
|
||||
|
||||
# 生产构建
|
||||
npm run build
|
||||
|
||||
# 如需预览
|
||||
npm run preview
|
||||
```
|
||||
|
||||
- 确保构建成功无错误
|
||||
- 向用户报告部署完成
|
||||
|
||||
---
|
||||
|
||||
## 附件
|
||||
|
||||
- [需求分析-模板.md](./需求分析-模板.md)
|
||||
- [实现方案-模板.md](./实现方案-模板.md)
|
||||
- [测试方案-模板.md](./测试方案-模板.md)
|
||||
- [经验记录.md](./经验记录.md)
|
||||
74
工程分析/实现方案-模板.md
Normal file
74
工程分析/实现方案-模板.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# 实现方案
|
||||
|
||||
> 时间戳:{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}
|
||||
> 对应需求分析:`需求分析-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md`
|
||||
|
||||
---
|
||||
|
||||
## 1. 方案概述
|
||||
|
||||
(用 2-3 句话概括整体实现思路)
|
||||
|
||||
---
|
||||
|
||||
## 2. 详细改动清单
|
||||
|
||||
### 2.1 文件:xxx.tsx
|
||||
|
||||
| 行号范围 | 改动类型 | 说明 |
|
||||
|----------|----------|------|
|
||||
| | 新增/修改/删除 | |
|
||||
|
||||
**具体代码逻辑**:
|
||||
```typescript
|
||||
// 关键代码片段或伪代码
|
||||
```
|
||||
|
||||
### 2.2 文件:yyy.ts
|
||||
|
||||
(同上格式)
|
||||
|
||||
---
|
||||
|
||||
## 3. 关键设计决策
|
||||
|
||||
| 决策点 | 选择方案 | 备选方案 | 不选备选的原因 |
|
||||
|--------|----------|----------|----------------|
|
||||
| | | | |
|
||||
|
||||
---
|
||||
|
||||
## 4. 与现有规范的兼容性检查
|
||||
|
||||
- [ ] contentEditable 规范(5.1)
|
||||
- [ ] 自动保存与草稿机制(5.2)
|
||||
- [ ] 图片与视频处理(5.3)
|
||||
- [ ] 智能字段与动态表单(5.4)
|
||||
- [ ] AI 功能开发规范(5.5)
|
||||
- [ ] 数据迁移与类型安全(5.6)
|
||||
- [ ] UI/UX 通用规范(5.7)
|
||||
|
||||
---
|
||||
|
||||
## 5. 回滚策略
|
||||
|
||||
若方案执行失败或验证不通过,如何快速回滚:
|
||||
|
||||
```bash
|
||||
# 回滚命令(示例)
|
||||
git reset --hard HEAD~1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. 预估工作量
|
||||
|
||||
| 阶段 | 预估时间 |
|
||||
|------|----------|
|
||||
| 代码修改 | |
|
||||
| 测试验证 | |
|
||||
| 文档更新 | |
|
||||
|
||||
---
|
||||
|
||||
**状态**:□ 待审核 | □ 已确认 | □ 已驳回(原因:)
|
||||
76
工程分析/测试方案-模板.md
Normal file
76
工程分析/测试方案-模板.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# 测试方案
|
||||
|
||||
> 时间戳:{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}
|
||||
> 对应需求分析:`需求分析-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md`
|
||||
> 对应实现方案:`实现方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md`
|
||||
|
||||
---
|
||||
|
||||
## 1. 测试环境
|
||||
|
||||
- 浏览器:
|
||||
- Node 版本:
|
||||
- 是否使用默认测试数据:□ 是 / □ 否
|
||||
|
||||
---
|
||||
|
||||
## 2. 功能测试用例
|
||||
|
||||
| 用例ID | 测试场景 | 操作步骤 | 预期结果 | 实际结果 | 是否通过 |
|
||||
|--------|----------|----------|----------|----------|----------|
|
||||
| TC-01 | | 1. <br>2. | | | □ |
|
||||
| TC-02 | | 1. <br>2. | | | □ |
|
||||
|
||||
---
|
||||
|
||||
## 3. 边界测试
|
||||
|
||||
| 场景 | 测试内容 | 预期表现 |
|
||||
|------|----------|----------|
|
||||
| 空数据 | | |
|
||||
| 大数据量 | | |
|
||||
| 异常输入 | | |
|
||||
|
||||
---
|
||||
|
||||
## 4. 回归测试范围
|
||||
|
||||
(列出可能受影响的已有功能,需验证未被破坏)
|
||||
|
||||
- [ ] 功能 A
|
||||
- [ ] 功能 B
|
||||
|
||||
---
|
||||
|
||||
## 5. 类型检查
|
||||
|
||||
```bash
|
||||
npm run lint
|
||||
```
|
||||
|
||||
- 预期结果:`tsc --noEmit` 无错误
|
||||
|
||||
---
|
||||
|
||||
## 6. 构建验证
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
- 预期结果:构建成功,无报错,产物输出至 `dist/`
|
||||
|
||||
---
|
||||
|
||||
## 7. 测试结论
|
||||
|
||||
| 项目 | 结果 |
|
||||
|------|------|
|
||||
| 功能测试 | □ 通过 / □ 部分通过 / □ 未通过 |
|
||||
| 类型检查 | □ 通过 / □ 未通过 |
|
||||
| 构建验证 | □ 通过 / □ 未通过 |
|
||||
| 整体结论 | □ 可交付 / □ 需修复后复测 |
|
||||
|
||||
---
|
||||
|
||||
**状态**:□ 待审核 | □ 已确认 | □ 已驳回(原因:)
|
||||
32
工程分析/经验记录.md
Normal file
32
工程分析/经验记录.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 经验记录
|
||||
|
||||
> 本文档用于沉淀项目修改过程中遇到的关键问题及解决方案。
|
||||
> 每次执行工作流 Step 5 后,按四段式追加新记录。
|
||||
> 执行修改前必须阅读本文档,避免重复踩坑。
|
||||
|
||||
---
|
||||
|
||||
## 记录格式
|
||||
|
||||
```markdown
|
||||
## [{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}] 问题简述
|
||||
|
||||
### A. 具体问题
|
||||
(描述遇到的现象或错误)
|
||||
|
||||
### B. 产生问题原因
|
||||
(根因分析)
|
||||
|
||||
### C. 解决问题方案
|
||||
(具体的解决步骤或代码改动)
|
||||
|
||||
### D. 后续如何避免问题
|
||||
(预防措施、规范建议、检查清单项)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 历史记录
|
||||
|
||||
(以下为实际踩坑记录,按时间倒序排列)
|
||||
|
||||
49
工程分析/需求分析-模板.md
Normal file
49
工程分析/需求分析-模板.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# 需求分析
|
||||
|
||||
> 时间戳:{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}
|
||||
|
||||
---
|
||||
|
||||
## 1. 原始需求描述
|
||||
|
||||
(用户原始表述,尽量保持原话)
|
||||
|
||||
---
|
||||
|
||||
## 2. 需求拆解
|
||||
|
||||
| 序号 | 子需求 | 涉及页面/模块 | 优先级 |
|
||||
|------|--------|---------------|--------|
|
||||
| 1 | | | |
|
||||
| 2 | | | |
|
||||
| 3 | | | |
|
||||
|
||||
---
|
||||
|
||||
## 3. 影响范围评估
|
||||
|
||||
### 3.1 需要修改的文件
|
||||
- `src/...`
|
||||
- `src/...`
|
||||
|
||||
### 3.2 潜在风险点
|
||||
-
|
||||
-
|
||||
|
||||
### 3.3 是否涉及数据迁移
|
||||
- [ ] 否
|
||||
- [ ] 是,说明:
|
||||
|
||||
---
|
||||
|
||||
## 4. 验收标准
|
||||
|
||||
- [ ] 标准1:
|
||||
- [ ] 标准2:
|
||||
- [ ] 标准3:
|
||||
|
||||
---
|
||||
|
||||
## 5. 关联历史需求
|
||||
|
||||
(如有相似或相关历史修改,在此引用对应的需求分析文档)
|
||||
Reference in New Issue
Block a user