189 lines
3.2 KiB
Markdown
189 lines
3.2 KiB
Markdown
# 功能更新: {{FEATURE_NAME}}
|
||
|
||
**日期**: {{DATE}}
|
||
**开发者**: {{AUTHOR}}
|
||
**相关Issue**: #{{ISSUE_NUMBER}}(如有)
|
||
**Git Commit**: {{COMMIT_HASH}}
|
||
|
||
---
|
||
|
||
## 功能概述
|
||
|
||
{{简要描述新功能的目的和价值,1-2句话说明为什么需要这个功能}}
|
||
|
||
## 需求背景
|
||
|
||
{{详细描述需求背景、使用场景、要解决的问题}}
|
||
|
||
### 用户场景
|
||
- **场景1**: {{描述使用场景1}}
|
||
- **场景2**: {{描述使用场景2}}
|
||
|
||
### 功能目标
|
||
- {{目标1}}
|
||
- {{目标2}}
|
||
- {{目标3}}
|
||
|
||
## 设计方案
|
||
|
||
{{技术设计方案描述}}
|
||
|
||
### 架构设计
|
||
|
||
{{如有架构层面的变更或新增模块,在此说明}}
|
||
|
||
```
|
||
[架构图或流程图的ASCII描述,或引用外部图片]
|
||
```
|
||
|
||
### 模块划分
|
||
|
||
- **模块1**: {{模块1功能说明}}
|
||
- **模块2**: {{模块2功能说明}}
|
||
- **模块3**: {{模块3功能说明}}
|
||
|
||
### 数据结构
|
||
|
||
```cpp
|
||
// 新增或修改的数据结构
|
||
{{数据结构定义}}
|
||
```
|
||
|
||
### API设计
|
||
|
||
```cpp
|
||
// 公开接口
|
||
{{API接口定义}}
|
||
```
|
||
|
||
#### 接口说明
|
||
|
||
| 接口名称 | 参数 | 返回值 | 功能说明 |
|
||
|---------|------|--------|---------|
|
||
| {{API1}} | {{参数}} | {{返回值}} | {{说明}} |
|
||
| {{API2}} | {{参数}} | {{返回值}} | {{说明}} |
|
||
|
||
## 实现细节
|
||
|
||
### 新增文件
|
||
|
||
- `{{FILE_1}}` - {{文件功能说明}}
|
||
- `{{FILE_2}}` - {{文件功能说明}}
|
||
|
||
### 修改文件
|
||
|
||
- `{{FILE_3}}` - {{修改内容说明}}
|
||
- `{{FILE_4}}` - {{修改内容说明}}
|
||
|
||
### 核心代码
|
||
|
||
```cpp
|
||
{{核心实现代码片段}}
|
||
```
|
||
|
||
### 算法说明
|
||
|
||
{{如涉及特定算法,详细说明算法原理和实现}}
|
||
|
||
## 使用方法
|
||
|
||
### 基本用法
|
||
|
||
```cpp
|
||
// 示例代码1: 基本使用
|
||
{{示例代码}}
|
||
```
|
||
|
||
### 高级用法
|
||
|
||
```cpp
|
||
// 示例代码2: 高级特性
|
||
{{示例代码}}
|
||
```
|
||
|
||
### 配置说明
|
||
|
||
{{如有配置参数,说明配置方法和参数含义}}
|
||
|
||
| 参数名称 | 类型 | 默认值 | 说明 |
|
||
|---------|------|--------|------|
|
||
| {{PARAM1}} | {{TYPE}} | {{DEFAULT}} | {{说明}} |
|
||
|
||
## 测试验证
|
||
|
||
### 单元测试
|
||
|
||
```cpp
|
||
// 单元测试代码
|
||
{{测试代码}}
|
||
```
|
||
|
||
### 集成测试
|
||
|
||
{{描述集成测试场景和结果}}
|
||
|
||
### 性能测试
|
||
|
||
| 测试场景 | 执行时间 | 内存占用 | 备注 |
|
||
|---------|---------|---------|------|
|
||
| {{场景1}} | {{时间}} | {{内存}} | {{说明}} |
|
||
|
||
### 测试结果
|
||
|
||
- ✅ {{测试通过项1}}
|
||
- ✅ {{测试通过项2}}
|
||
- ✅ {{测试通过项3}}
|
||
|
||
## Git提交信息
|
||
|
||
```
|
||
Commit ID: {{COMMIT_HASH}}
|
||
Commit Message: {{COMMIT_MESSAGE}}
|
||
Branch: {{BRANCH_NAME}}
|
||
```
|
||
|
||
## 依赖关系
|
||
|
||
### 外部依赖
|
||
- {{依赖库1}} - {{版本}} - {{用途}}
|
||
- {{依赖库2}} - {{版本}} - {{用途}}
|
||
|
||
### 内部依赖
|
||
- {{模块1}} - {{依赖关系说明}}
|
||
- {{模块2}} - {{依赖关系说明}}
|
||
|
||
## 兼容性说明
|
||
|
||
### API兼容性
|
||
- {{是否破坏现有API}}
|
||
- {{迁移指南(如需要)}}
|
||
|
||
### 版本兼容性
|
||
- 最低支持版本: {{VERSION}}
|
||
- 推荐版本: {{VERSION}}
|
||
|
||
## 已知问题
|
||
|
||
- {{问题1描述及临时解决方案}}
|
||
- {{问题2描述及临时解决方案}}
|
||
|
||
## 后续计划
|
||
|
||
- [ ] {{待完善的功能1}}
|
||
- [ ] {{待完善的功能2}}
|
||
- [ ] {{性能优化计划}}
|
||
|
||
## 相关文档
|
||
|
||
- [{{相关文档1}}]({{LINK1}})
|
||
- [{{相关文档2}}]({{LINK2}})
|
||
|
||
## 备注
|
||
|
||
{{其他需要说明的内容}}
|
||
|
||
---
|
||
|
||
**归档位置**: `archives/updates/{{DATE}}_{{FEATURE_NAME}}/`
|
||
**文档副本**: `docs/updates/`
|