120 lines
3.3 KiB
Markdown
120 lines
3.3 KiB
Markdown
|
# 项目维护和更新原则
|
|||
|
|
|
|||
|
|
## 核心原则
|
|||
|
|
|
|||
|
|
### 1. Web Result 项目变更同步原则
|
|||
|
|
**重要性：⭐⭐⭐⭐⭐**
|
|||
|
|
|
|||
|
|
任何 web_result 项目的变更都**必须**立即更新到 Serena 记忆系统中，确保文档与代码保持同步。
|
|||
|
|
|
|||
|
|
#### 需要更新记忆的情况：
|
|||
|
|
- ✅ 新增订单班展示页面
|
|||
|
|
- ✅ 修改路由配置（routes.yaml）
|
|||
|
|
- ✅ 更改服务器配置（app.js, server.js）
|
|||
|
|
- ✅ 调整页面结构或样式
|
|||
|
|
- ✅ 添加新的 JavaScript 模块
|
|||
|
|
- ✅ 修改访问端口或路径
|
|||
|
|
- ✅ 更新技术栈或依赖
|
|||
|
|
- ✅ 优化性能或修复问题
|
|||
|
|
|
|||
|
|
#### 更新方式：
|
|||
|
|
```bash
|
|||
|
|
# 当 web_result 项目发生变更时
|
|||
|
|
1. 完成代码修改
|
|||
|
|
2. 测试功能正常
|
|||
|
|
3. 立即更新 Serena 记忆：
|
|||
|
|
- 更新 "07_web_result项目架构和订单班展示系统.md"
|
|||
|
|
- 记录变更内容、原因和时间
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 2. 终端模拟系统变更同步
|
|||
|
|
终端模拟系统（exhibition-demo）的变更也需要同步更新：
|
|||
|
|
- 更新 "02_终端模拟开发指南.md"
|
|||
|
|
- 更新 "03_订单班配置清单.md"
|
|||
|
|
|
|||
|
|
### 3. 记忆更新规范
|
|||
|
|
|
|||
|
|
#### 更新格式：
|
|||
|
|
```markdown
|
|||
|
|
## 更新记录
|
|||
|
|
|
|||
|
|
### [日期] - [变更类型]
|
|||
|
|
**变更内容**：
|
|||
|
|
- 具体修改项1
|
|||
|
|
- 具体修改项2
|
|||
|
|
|
|||
|
|
**影响范围**：
|
|||
|
|
- 影响的功能模块
|
|||
|
|
- 影响的订单班
|
|||
|
|
|
|||
|
|
**相关文件**：
|
|||
|
|
- 修改的文件路径
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 4. 关联记忆维护
|
|||
|
|
|
|||
|
|
当一个系统变更时，需要检查并更新相关联的记忆：
|
|||
|
|
|
|||
|
|
| 系统模块 | 主记忆文件 | 关联记忆 |
|
|||
|
|
|---------|-----------|---------|
|
|||
|
|
| web_result | 07_web_result项目架构 | 01_项目概述、05_运行命令 |
|
|||
|
|
| 终端模拟 | 02_终端模拟开发指南 | 03_订单班配置、06_问题解决 |
|
|||
|
|
| SuperDesign | 04_SuperDesign工作流 | 07_web_result项目架构 |
|
|||
|
|
| 订单班配置 | 03_订单班配置清单 | 02_终端模拟、07_web_result |
|
|||
|
|
|
|||
|
|
### 5. 变更通知机制
|
|||
|
|
|
|||
|
|
重大变更需要在相关记忆文件顶部添加通知：
|
|||
|
|
```markdown
|
|||
|
|
> ⚠️ **重要更新** [日期]：[简述变更内容]
|
|||
|
|
> 详见更新记录章节
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 6. 版本控制建议
|
|||
|
|
|
|||
|
|
对于重大架构变更：
|
|||
|
|
1. 在记忆文件中保留历史版本说明
|
|||
|
|
2. 记录迁移路径
|
|||
|
|
3. 标注废弃的功能或方法
|
|||
|
|
|
|||
|
|
### 7. 记忆文件命名规范
|
|||
|
|
|
|||
|
|
- 00-09：基础和索引类
|
|||
|
|
- 10-19：架构和系统类
|
|||
|
|
- 20-29：功能模块类
|
|||
|
|
- 30-39：订单班相关
|
|||
|
|
- 40-49：问题和优化类
|
|||
|
|
- 90-99：临时和实验性
|
|||
|
|
|
|||
|
|
### 8. 记忆更新检查清单
|
|||
|
|
|
|||
|
|
更新前检查：
|
|||
|
|
- [ ] 代码已测试通过
|
|||
|
|
- [ ] 影响范围已评估
|
|||
|
|
- [ ] 相关记忆已识别
|
|||
|
|
- [ ] 更新内容准备完整
|
|||
|
|
|
|||
|
|
更新后验证：
|
|||
|
|
- [ ] 主记忆已更新
|
|||
|
|
- [ ] 关联记忆已同步
|
|||
|
|
- [ ] 更新记录已添加
|
|||
|
|
- [ ] 版本信息已标注
|
|||
|
|
|
|||
|
|
## 特别提醒
|
|||
|
|
|
|||
|
|
### Web Result 项目特别注意事项：
|
|||
|
|
1. **路由变更**：必须同步更新 routes.yaml 说明
|
|||
|
|
2. **新订单班**：必须更新订单班清单和实现方式
|
|||
|
|
3. **样式系统**：CSS 框架或动画系统变更需详细记录
|
|||
|
|
4. **性能优化**：记录优化前后的对比和方法
|
|||
|
|
5. **部署配置**：端口、路径等变更立即更新
|
|||
|
|
|
|||
|
|
### 记忆系统维护责任：
|
|||
|
|
> **核心原则**：代码变更与文档同步是项目可维护性的基础。
|
|||
|
|
> 每次修改 web_result 或其他核心系统后，**必须**第一时间更新 Serena 记忆。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
创建时间：2024年12月
|
|||
|
|
最后更新：2024年12月
|
|||
|
|
维护等级：最高优先级
|