2.7 KiB
2.7 KiB
代码编纂工作流
本工作流为项目修改类需求的标准执行流程。后续所有项目修改相关需求,均需严格按以下步骤执行。
前置约定
- 时间戳格式:
{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}- 示例:
2026-04-16-18-35-00
- 示例:
- 所有方案文档均存放于
.\工程分析\目录下。
执行步骤
Step 0. 记录开始时间
每次执行前,以当前时间生成时间戳,作为本次需求的唯一标识。
Step 1. 创建/确认工程分析目录
确保 .\工程分析\ 文件夹存在。如不存在,则自动创建。
Step 2. 需求分析
将用户提出的需求整理、拆解、澄清后,写入文档:
.\工程分析\需求分析-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md
内容要求:
- 原始需求摘要
- 需求拆解(功能点 / 非功能点)
- 待确认问题(如有)
- 影响范围预估
Step 3. 实现方案(需人工确认)
基于需求分析,撰写详细的实现方案,写入文档:
.\工程分析\实现方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md
内容要求:
- 实现思路与架构决策
- 涉及修改的文件清单
- 具体的代码变更说明
- 风险点与回滚策略
⚠️ 此文档写完后,必须提交给用户进行二次人工审核确认,得到明确批准后方可进入下一步。
Step 4. 测试方案(需人工确认)
基于实现方案,撰写测试方案,写入文档:
.\工程分析\测试方案-{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec}.md
内容要求:
- 测试目标
- 测试用例设计
- 测试环境准备
- 验收标准
⚠️ 此文档写完后,必须提交给用户进行二次人工审核确认,得到明确批准后方可进入下一步。
Step 5. 执行修改前准备
- 阅读
.\工程分析\经验记录.md,回顾历史问题,避免重复犯错。 - 确认实现方案和测试方案均已获得用户批准。
Step 6. 执行修改
按照已批准的实现方案和测试方案,执行具体的代码修改与测试验证。
Step 7. 更新经验记录
修改完成后,将本次执行过程中遇到的关键问题及解决方案,以 四段式 追加写入 .\工程分析\经验记录.md:
- A. 具体问题
- B. 产生问题原因
- C. 解决问题方案
- D. 后续如何避免问题
Step 8. Gitea 备份 Commit
将 .\工程分析\ 目录下的所有文档使用 Gitea 进行备份,提交 Commit。
Commit Message 格式:
{Year}-{Mon}-{Day}-{Hour}-{Min}-{Sec} - {本次修改的简要描述}
Commit 完成后,提醒用户备份已完成。
当前状态
- 工作流文档建立
- 工程分析目录创建
- 经验记录初始文档创建