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)
|
||||
Reference in New Issue
Block a user