84 lines
3.5 KiB
Markdown
84 lines
3.5 KiB
Markdown
# 实现方案 —— 2026-04-18-16-45-02
|
||
|
||
## 方案目标
|
||
建立一套标准化、可复用的代码编纂工作流，确保后续所有项目修改需求都能按统一流程执行，减少遗漏和错误。
|
||
|
||
## 方案内容
|
||
|
||
### 阶段一：工程分析文件夹确认（步骤 1）
|
||
1. 检查 `.\工程分析` 文件夹是否存在。
|
||
2. 若不存在则创建；若存在则确认其包含以下文件类型：
|
||
- `需求分析-*.md`
|
||
- `实现方案-*.md`
|
||
- `测试方案-*.md`
|
||
- `经验记录.md`
|
||
|
||
### 阶段二：需求分析文档生成（步骤 2）
|
||
每次用户提出修改需求时：
|
||
1. 记录开始时间 `{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}`。
|
||
2. 创建 `.\工程分析\需求分析-{时间}.md`。
|
||
3. 文档内容包含：
|
||
- 需求来源
|
||
- 需求概述（一句话描述）
|
||
- 功能详细描述
|
||
- 涉及文件/模块清单
|
||
- 需求影响范围
|
||
|
||
### 阶段三：实现方案文档生成与用户审核（步骤 3）
|
||
1. 基于需求分析，编写 `.\工程分析\实现方案-{时间}.md`。
|
||
2. 文档内容包含：
|
||
- 方案目标
|
||
- 具体实现步骤（分阶段）
|
||
- 涉及文件及修改点
|
||
- 风险与注意事项
|
||
3. **此处为强制审核节点**：文档生成后停止执行，等待用户确认"方案无误，继续执行"。
|
||
4. 用户确认后方可进入下一阶段。
|
||
|
||
### 阶段四：测试方案文档生成与用户审核（步骤 4）
|
||
1. 基于实现方案，编写 `.\工程分析\测试方案-{时间}.md`。
|
||
2. 文档内容包含：
|
||
- 测试目标
|
||
- 测试用例清单（编号、操作步骤、预期结果）
|
||
- 回归测试范围
|
||
3. **此处为强制审核节点**：文档生成后停止执行，等待用户确认"方案无误，继续执行"。
|
||
4. 用户确认后方可进入下一阶段。
|
||
|
||
### 阶段五：经验记录阅读与执行（步骤 5）
|
||
1. **执行前**：读取 `.\工程分析\经验记录.md`，提取与本次修改相关的经验条目。
|
||
2. **执行中**：按照已审核的实现方案修改代码。
|
||
3. **执行后**：若过程中遇到新的关键问题，按四段式追加到 `.\工程分析\经验记录.md`：
|
||
- A. 具体问题
|
||
- B. 产生问题原因
|
||
- C. 解决问题方案
|
||
- D. 后续如何避免问题
|
||
|
||
### 阶段六：Gitea 备份（步骤 6）
|
||
1. 执行以下 Git 操作：
|
||
```bash
|
||
git add .
|
||
git commit -m "{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec} - {简要描述}"
|
||
git push origin main
|
||
git tag -a v{版本号} -m "{版本描述}"
|
||
git push origin v{版本号}
|
||
```
|
||
2. 向用户汇报备份完成。
|
||
|
||
### 阶段七：重新部署（步骤 7）
|
||
1. 执行 `npm run build` 构建生产版本。
|
||
2. 验证构建产物 `dist/` 已生成。
|
||
3. 启动预览服务 `npm run preview`（或用户指定的部署方式）。
|
||
|
||
## 工作流强制审核点
|
||
| 审核点 | 触发条件 | 用户操作 |
|
||
|--------|----------|----------|
|
||
| 实现方案审核 | 实现方案文档生成完毕 | 用户阅读并回复"确认" |
|
||
| 测试方案审核 | 测试方案文档生成完毕 | 用户阅读并回复"确认" |
|
||
|
||
## 本次（建立工作流）的执行差异
|
||
由于本次需求不涉及业务代码修改，阶段五（代码执行）、阶段六（备份）、阶段七（部署）均跳过或简化处理。重点在于将工作流规范文档化并确认用户理解。
|
||
|
||
## 风险与注意事项
|
||
1. 用户必须理解两个强制审核节点（实现方案、测试方案），不可跳过。
|
||
2. 若用户在审核阶段提出修改意见，需重新生成对应文档并再次等待确认。
|
||
3. 经验记录文档需持续维护，成为项目知识库的核心资产。
|