56 lines
2.4 KiB
Markdown
56 lines
2.4 KiB
Markdown
# 需求分析 —— 2026-04-18-16-45-02
|
|
|
|
## 需求来源
|
|
用户明确要求建立一套标准化的代码编纂工作流，用于规范后续所有项目修改需求的处理流程。
|
|
|
|
## 需求概述
|
|
新建一个完整的代码编纂工作流。后续用户提出的任何项目修改相关需求，都必须严格按照该工作流执行。
|
|
|
|
## 工作流步骤定义
|
|
|
|
### 0. 时间记录
|
|
每次执行前，记录问题开始的时间，格式为 `{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}`。
|
|
|
|
### 1. 工程分析文件夹
|
|
阅读或创建 `.\工程分析` 文件夹，用于存放对整个工程的整体分析文档。
|
|
|
|
### 2. 需求分析文档
|
|
每次用户提出的需求，都整理写入 `.\工程分析\需求分析-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md` 文档中。
|
|
|
|
### 3. 实现方案文档
|
|
每次将实现方案写入 `.\工程分析\实现方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md` 文档中。
|
|
**关键约束**：该文档写完后必须经过用户二次人工审核确认，方可进入下一步。
|
|
|
|
### 4. 测试方案文档
|
|
将测试方案写入 `.\工程分析\测试方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md` 文档中。
|
|
**关键约束**：该文档写完后必须经过用户二次人工审核确认，方可进入下一步。
|
|
|
|
### 5. 经验记录与知识库
|
|
- **执行前**：阅读 `.\工程分析\经验记录.md`，防止重复犯错。
|
|
- **执行后**：在 `.\工程分析\经验记录.md` 中，将执行过程中遇到的关键问题及解决方案，按以下四段式格式追加记录：
|
|
- A. 具体问题
|
|
- B. 产生问题原因
|
|
- C. 解决问题方案
|
|
- D. 后续如何避免问题
|
|
|
|
### 6. Gitea 备份
|
|
最终执行完成后，使用 Gitea 对文档进行备份。Commit 信息需包含：
|
|
- `{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}` 时间戳
|
|
- 对本次修改的简要描述
|
|
完成后提醒用户已完成文档备份。
|
|
|
|
### 7. 重新部署
|
|
最终执行完成后，重新执行 `npm` 部署本项目。
|
|
|
|
## 本次需求的特殊性
|
|
本次需求本身即为"建立工作流规范"，不涉及具体业务代码的增删改。因此实现内容主要是：
|
|
1. 确认 `.\工程分析` 目录结构已就绪
|
|
2. 将工作流规范固化为可重复执行的流程文档
|
|
3. 确保用户理解每个步骤的审核节点
|
|
|
|
## 需求影响范围
|
|
- 工程分析文档体系
|
|
- 后续所有项目修改需求的执行方式
|
|
- Gitea 备份流程
|
|
- 无业务代码变更
|