docs: 添加产品管理模板中心

包含完整的产品管理文档模板:
- PRD 需求文档模板
- 功能点拆解模板
- API 文档模板
- 测试用例模板
- 发布与回滚模板
- ADR 决策记录模板
- 会议纪要模板
This commit is contained in:
杨志鑫 2026-01-21 10:22:16 +08:00
parent 726af1bdce
commit 5986922003
8 changed files with 591 additions and 0 deletions

View File

@ -0,0 +1,110 @@
---
type: template
template_id: PRD
tags:
- 文档/PRD
status: draft
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.1PRD 母版(产品需求说明书)
> [!summary] 文档基础信息
> * **文档名称**
> * **时间阶段**`2025` / `2026` (必填)
> * **文档属性**`工程态` / `注册态` (必填)
> * **PRD 编号**`PRD-XXXX`
> * **版本号**`Vx.x`
> * **文档状态**`草稿` / `评审中` / `已冻结`
> * **产品负责人**
> * **关联角色**`前端` / `后端` / `算法` / `仿真` / `测试`
> * **适用阶段**`验证` / `开发` / `试点` / `商用`
> * **创建日期**{{date}}
> * **最近更新**{{date}}
---
## 1. 背景与目标
### 1.1 背景说明
> (为什么要做?业务驱动力是什么?)
### 1.2 问题定义
> (当前痛点 / 待解决的问题)
### 1.3 本版本目标
> 明确可验证的业务目标SMART 原则)
### 1.4 不在本版本范围Out of Scope
> (明确不做及其原因,管理预期)
---
## 2. 用户与使用场景
### 2.1 用户角色定义
| 角色名称 | 职责描述 | 核心关注点 |
| :--- | :--- | :--- |
| | | |
### 2.2 典型使用场景 (User Stories)
> 作为 <角色>,我想要 <功能>,以便于 <价值>
### 2.3 用户核心诉求
---
## 3. 功能范围总览
### 3.1 功能模块列表
| 模块 ID | 模块名称 | 优先级 | 简述 |
| :--- | :--- | :--- | :--- |
| M-01 | | P0 | |
### 3.2 模块依赖关系
> (可选:使用 Mermaid 绘制模块依赖图)
---
## 4. 功能说明(仅描述“做什么”)
### 4.1 [模块名称]
#### 4.1.1 功能描述
> 详细描述该功能点的业务逻辑。
#### 4.1.2 功能目标
> 该功能期望达成的具体效果。
#### 4.1.3 关联功能点 ID
> 对应 `00.2_功能点拆解` 中的 ID`FN-XXXX`
---
## 5. 非功能需求 (NFR)
### 5.1 性能要求
* 响应时间:
* 并发量:
### 5.2 安全与合规
* 权限要求:
* 数据脱敏:
### 5.3 数据与隐私
* 数据留存期:
---
## 6. 验收标准
### 6.1 功能验收原则
1. [ ]
2. [ ]
### 6.2 算法 / 仿真验收原则(如适用)
* 准确率指标:
* 召回率指标:

View File

@ -0,0 +1,85 @@
---
type: template
template_id: Feature-Node
tags:
- 文档/功能拆解
status: planning
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.2|功能点拆解母版(全流程枢纽)
> [!summary] 功能点基本信息
> * **时间阶段**`2025` / `2026` (必填)
> * **文档属性**`工程态` / `注册态` (必填)
> * **功能点 ID**`FN-XXXX`
> * **功能点名称**
> * **所属模块**
> * **关联 PRD**`[[PRD-XXXX]]`
---
## 1. 责任角色矩阵
| 角色 | 负责人 | 状态 | 备注 |
| :--- | :--- | :--- | :--- |
| **产品** | | | |
| **前端** | | | |
| **后端** | | | |
| **算法** | | | |
| **仿真** | | | |
| **测试** | | | |
---
## 2. 触发条件
> 用户点击某按钮 / 系统定时任务 / 外部 API 回调 / 消息队列消息
---
## 3. 主流程(必须可执行)
> 描述数据流转和系统交互的详细步骤。
1.
2.
3.
---
## 4. 异常与边界
### 4.1 异常场景
| 场景 | 处理策略 | 提示文案 |
| :--- | :--- | :--- |
| 网络超时 | 重试 3 次 | "网络异常,请稍后" |
| 数据为空 | 展示缺省页 | "暂无数据" |
### 4.2 边界条件
> 最大值、最小值、特殊字符、并发限制等。
### 4.3 降级或兜底策略
> 当核心服务不可用时,系统如何表现?
---
## 5. 输入与输出定义
### 5.1 输入 (Input)
* **数据来源**:用户输入 / 数据库 / 上游服务
* **关键字段**
* `field_A` (String, 必填): 说明
### 5.2 输出 (Output)
* **输出结果**:页面展示 / 数据库落表 / 消息通知
* **展示 / 存储方式**
---
## 6. 验收与追溯
* **验收点说明**
* **关联接口 ID**`[[API-XXXX]]`
* **关联测试用例 ID**`[[TC-XXXX]]`

View File

@ -0,0 +1,91 @@
---
type: template
template_id: API-Doc
tags:
- 文档/API
status: design
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.3API 文档母版
> [!summary] 接口基础信息
> * **时间阶段**`2025` / `2026` (必填)
> * **文档属性**`工程态` / `注册态` (必填)
> * **接口编号**`API-XXXX`
> * **接口名称**
> * **所属服务**`前端` / `后端` / `算法服务`
> * **接口版本**`Vx.x`
> * **维护人**
---
## 1. 请求说明 (Request)
* **URL**: `/api/v1/resource/...`
* **Method**: `GET` / `POST` / `PUT` / `DELETE`
* **Content-Type**: `application/json`
### 1.1 Header 说明
| Key | Value | 必填 | 说明 |
| :--- | :--- | :--- | :--- |
| Authorization | Bearer token | 是 | 用户凭证 |
### 1.2 请求参数 (Body / Query)
| 参数名 | 类型 | 必填 | 示例值 | 说明 |
| :--- | :--- | :--- | :--- | :--- |
| `id` | String | 是 | "12345" | 资源 ID |
| `name` | String | 否 | "Test" | 名称 |
---
## 2. 返回说明 (Response)
### 2.1 成功响应示例 (HTTP 200)
```json
{
"code": 200,
"message": "success",
"data": {
"id": "12345",
"status": "active"
}
}
```
### 2.2 字段说明
| 字段名 | 类型 | 说明 |
| :--- | :--- | :--- |
| `code` | Number | 业务状态码 |
| `data` | Object | 业务数据 |
---
## 3. 错误码定义 (Error Codes)
| 错误码 (code) | 含义 | HTTP Status | 处理建议 |
| :--- | :--- | :--- | :--- |
| 40001 | 参数错误 | 400 | 检查参数格式 |
| 40100 | 未授权 | 401 | 跳转登录 |
| 50000 | 系统内部错误 | 500 | 联系管理员 |
---
## 4. 权限与安全
* **鉴权方式**`Token` / `Cookie` / `API Key`
* **权限控制**:仅 `Admin` 角色可调用
---
## 5. 版本变更记录
| 版本 | 日期 | 变更人 | 变更内容 |
| :--- | :--- | :--- | :--- |
| V1.0 | {{date}} | | 初始版本创建 |

View File

@ -0,0 +1,64 @@
---
type: template
template_id: TestCase
tags:
- 文档/测试用例
status: draft
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.4|测试用例母版
> [!summary] 用例基本信息
> * **时间阶段**`2025` / `2026` (必填)
> * **文档属性**`工程态` / `注册态` (必填)
> * **用例 ID**`TC-XXXX`
> * **关联功能点**`[[FN-XXXX]]`
> * **用例类型**`功能` / `算法` / `仿真` / `性能` / `安全`
> * **优先级**`P0` / `P1` / `P2`
---
## 1. 前置条件 (Pre-conditions)
* **数据准备**
* 需要预置的用户数据?
* 数据库状态?
* **环境要求**
* 指定浏览器版本?
* 指定硬件设备?
* 依赖服务状态?
---
## 2. 操作步骤 (Steps)
1.
2.
3.
---
## 3. 预期结果 (Expected Result)
> 详细描述每一步操作后的系统反应、页面跳转、数据变化。
* 界面展示:
* 数据库变更:
* 接口返回:
---
## 4. 实际结果记录 (Actual Result)
> [!NOTE] 执行记录
> * **执行人**
> * **执行日期**{{date}}
> * **是否通过**`Pass` / `Fail` / `Block`
* **问题描述**(如果失败):
* **关联 Bug ID**
* **备注**

View File

@ -0,0 +1,81 @@
---
type: template
template_id: Release-Plan
tags:
- 文档/发布计划
status: planning
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.5|发布与回滚母版
> [!summary] 发布基本信息
> * **时间阶段**`2025` / `2026` (必填)
> * **文档属性**`工程态` / `注册态` (必填)
> * **发布版本**`Vx.x.x`
> * **发布范围**`前端` / `后端` / `算法` / `仿真`
> * **发布负责人**
> * **发布日期**{{date}}
> * **预计时长**
---
## 1. 发布前检查 (Pre-check)
### 1.1 准入条件
- [ ] 功能测试全部通过(无 P0/P1 Bug
- [ ] 性能测试达标
- [ ] 算法/仿真效果验证通过
- [ ] 代码已合并至 Release 分支
- [ ] 数据库变更脚本已准备 (SQL Review 通过)
### 1.2 环境确认
- [ ] 生产环境配置检查
- [ ] 依赖服务状态检查
---
## 2. 发布步骤 (Execution Steps)
> 按时间序详细列出操作步骤。
| 序号 | 步骤描述 | 执行人 | 预计开始时间 | 状态 |
| :--- | :--- | :--- | :--- | :--- |
| 1 | 停服 / 摘除流量 | | | 待执行 |
| 2 | 数据库变更 (DDL/DML) | | | 待执行 |
| 3 | 后端服务部署 | | | 待执行 |
| 4 | 前端资源发布 | | | 待执行 |
| 5 | 服务健康检查 | | | 待执行 |
| 6 | 恢复流量 | | | 待执行 |
---
## 3. 发布后验证 (Verification)
### 3.1 核心功能回归 (Smoke Test)
- [ ] 登录/注册流程
- [ ] 核心业务流程 A
- [ ] 核心业务流程 B
### 3.2 核心指标确认
- [ ] 错误日志监控 (Error Rate)
- [ ] 系统负载 (CPU/Memory)
- [ ] 业务指标 (如订单量/活跃数)
---
## 4. 回滚方案 (Rollback Plan)
> [!DANGER] 紧急回滚
> **触发条件**
> 1. 核心业务流程阻断,且无法在 30 分钟内修复
> 2. 出现严重数据污染
> 3. 核心接口成功率低于 95%
### 回滚执行步骤
1.
2.
3.

View File

@ -0,0 +1,64 @@
---
type: template
template_id: ADR
tags:
- 文档/决策记录
status: decided
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.6ADR 决策记录母版 (Architecture Decision Record)
> [!summary] 决策概览
> * **时间阶段**`2025` / `2026`
> * **文档属性**`工程态` / `注册态`
> * **决策编号**`ADR-XXXX`
> * **决策主题**
> * **决策状态**`提议` / `已采纳` / `已废弃`
> * **决策人**
> * **日期**{{date}}
---
## 1. 决策背景 (Context)
> 说明面临的问题、痛点、技术约束或业务需求。
> * 为什么需要做这个决策?
> * 现在的方案有什么问题?
---
## 2. 备选方案 (Options)
### 方案 A[方案名称]
* **描述**
* **优点**
* **缺点**
### 方案 B[方案名称]
* **描述**
* **优点**
* **缺点**
---
## 3. 最终决策 (Decision)
> 我们决定采用 **[方案 X]**,因为...
---
## 4. 影响分析 (Consequences)
### 正面影响 (Positive)
*
### 负面影响 (Negative)
*
* (所有的决策都有代价,如增加了复杂度、引入了新依赖等)
### 风险与缓解措施
*

View File

@ -0,0 +1,62 @@
---
type: template
template_id: Meeting-Notes
tags:
- 文档/会议纪要
status: active
created: {{date}}
updated: {{date}}
phase: 2025
attribute: 工程态
---
# 00.7|会议纪要母版
> [!summary] 会议信息
> * **时间阶段**`2025` / `2026`
> * **文档属性**`工程态` / `注册态`
> * **会议主题**
> * **会议类型**`周会` / `评审` / `专项` / `站会`
> * **时间**{{date}} {{time}}
> * **地点/链接**
> * **主持人**
> * **记录人**
> * **参与人**
---
## 1. 会议议程 (Agenda)
1.
2.
3.
---
## 2. 核心讨论记录 (Discussion)
### 议题一:[标题]
* **观点 A** (发言人)
* **观点 B** (发言人)
* **结论**
### 议题二:[标题]
* ...
---
## 3. 结论摘要 (Decisions)
> [!SUCCESS] 决议
> 1. 确认...
> 2. 同意...
> 3. 否决...
---
## 4. 行动项清单 (Action Items)
| 行动项内容 | 负责人 | 截止时间 (Deadline) | 状态 | 备注 |
| :--- | :--- | :--- | :--- | :--- |
| | | | 待办 | |
| | | | 进行中 | |

34
00 模板中心/README.md Normal file
View File

@ -0,0 +1,34 @@
---
tags:
- 规范/模板管理
aliases:
- 模板使用指南
---
# 00模板中心母版库不写业务内容
> [!DANGER] 作用定位(强制说明)
> * 本目录是 **全项目唯一模板源头**Source of Truth
> * 仅定义【标准结构 / 固定字段 / 填写规范】
> * **禁止** 在此目录下写任何具体项目、功能、算法、版本内容
> * **其他所有文件夹中的文档,必须从此处模板复制生成**
> [!TIP] 使用方式
> 1. 打开所需模板文件
> 2. 复制文件内容(或使用 Obsidian 的 "Insert template" 功能)
> 3. 在目标目录创建新文件
> 4. 粘贴内容并开始填写
---
## 模板清单
| 编号 | 模板名称 | 适用场景 | 核心产出物 |
| :--- | :--- | :--- | :--- |
| **00.1** | [[00.1PRD母版|PRD 产品需求说明书]] | 产品定义阶段 | 明确“做什么” |
| **00.2** | [[00.2功能点拆解母版|功能点拆解清单]] | 需求转开发阶段 | 连接 PRD 与代码的枢纽 |
| **00.3** | [[00.3API文档母版|API 接口文档]] | 接口定义阶段 | 前后端/服务间契约 |
| **00.4** | [[00.4测试用例母版|测试用例]] | 测试设计阶段 | 验证标准 |
| **00.5** | [[00.5发布与回滚母版|发布与回滚方案]] | 上线部署阶段 | 操作手册 (SOP) |
| **00.6** | [[00.6ADR决策记录母版|ADR 架构决策记录]] | 技术/算法选型 | 决策依据快照 |
| **00.7** | [[00.7会议纪要母版|会议纪要]] | 各类会议 | 结论与行动项 |