feat: 根目录文档、脚本、gitignore

2026-10-08 16:15:33 +08:00
commit e98660ce4e
284 changed files with 26838 additions and 0 deletions
@@ -0,0 +1,343 @@
+# PRD 模板（pmassist-v3）
+
+> **使用说明**：按需裁剪，保留证据标注。所有关键结论需引用 `materials_index.md` 中的来源 ID。
+> FR 编号（FR-xxx）需与 `outputs/acceptance.md` 中的 AC 对应。
+
+---
+
+## 0. 文档信息
+
+| 字段 | 内容 |
+|---|---|
+| 版本 | v1.0 |
+| 状态 | 草稿 / 评审中 / 定稿 |
+| 作者 | |
+| 创建日期 | |
+| 最后更新 | |
+| 适用范围 | |
+
+### 变更记录
+
+| 版本 | 日期 | 变更编号 | 变更说明 | 影响章节 |
+|---|---|---|---|---|
+| v1.0 | | CHG-000 | 初稿 | 全部 |
+
+---
+
+## 1. 业务背景
+
+### 1.1 现状与痛点
+> 描述当前业务现状，用数据或事实证据支撑。
+
+- 现状描述：[SRC-001]
+- 核心痛点：
+  1. [ASSUMPTION]
+  2. [ASSUMPTION]
+
+### 1.2 业务目标与问题陈述
+> 本需求要解决的核心问题是什么？
+
+### 1.3 相关历史决策
+> 可链接 `decision_log.md` 中的历史决策。
+
+---
+
+## 2. 目标与成功指标
+
+### 2.1 业务目标（可量化）
+
+| 目标 | 指标 | 当前值 | 目标值 | 截止时间 |
+|---|---|---|---|---|
+| | | | | |
+
+### 2.2 北极星指标
+
+### 2.3 约束条件与边界
+- 时间约束：
+- 技术约束：
+- 合规约束：
+- 不在本期范围：
+
+---
+
+## 3. 用户与场景
+
+### 3.1 目标用户/角色
+
+| 角色 | 描述 | 典型诉求 |
+|---|---|---|
+| 运营 | | |
+| 用户/客户 | | |
+| 管理员 | | |
+
+### 3.2 关键使用场景
+
+| 场景编号 | 场景描述 | 涉及角色 | 优先级 |
+|---|---|---|---|
+| S-001 | | | P0 |
+| S-002 | | | P1 |
+
+### 3.3 价值链路与利益相关方
+
+```mermaid
+graph LR
+    A[角色1] --> B[操作] --> C[系统] --> D[结果]
+```
+
+---
+
+## 4. 需求范围
+
+### 4.1 范围内（In Scope）
+
+| 模块 | 功能 | 备注 |
+|---|---|---|
+| | | |
+
+### 4.2 范围外（Out of Scope）
+
+- 本期不做：
+  1. 
+  2. 
+
+### 4.3 假设与依赖
+
+| 依赖项 | 类型 | 状态 | 负责方 |
+|---|---|---|---|
+| | 内部/外部 | 待确认/已确认 | |
+
+---
+
+## 5. 整体方案介绍
+
+### 5.1 方案概述
+
+### 5.2 核心机制/策略
+
+### 5.3 结算/计费/策略规则（如适用）
+
+### 5.4 字段新增/调整
+
+| 字段名 | 表/对象 | 类型 | 说明 | 证据 |
+|---|---|---|---|---|
+| | | | | |
+
+### 5.5 方案对比与取舍
+
+| 方案 | 优点 | 缺点 | 结论 |
+|---|---|---|---|
+| 方案 A（选定）| | | ✅ 采用 |
+| 方案 B | | | ❌ 放弃 |
+
+---
+
+## 6. 需求内容
+
+### 6.1 端/渠道覆盖矩阵（强制）
+
+| 端/渠道 | 是否覆盖 | 核心差异点 | 涉及 FR | 证据 |
+|---|---|---|---|---|
+| 管理端 | ✅/❌/部分 | | FR-001~005 | |
+| 商户平台 | | | | |
+| 合伙人平台 | | | | |
+| 小程序/H5 | | | | |
+| API/开放接口 | | | | |
+| 其他端 | | | | |
+
+### 6.2 功能需求列表（FR）
+
+> **编号规则**：主功能 FR-001；子功能 FR-001-1。每条 FR 需有对应 AC（见 `outputs/acceptance.md`）。
+
+#### FR-001：{功能名称}
+
+- **优先级**：P0 / P1 / P2
+- **角色**：{涉及角色}
+- **触发条件**：WHEN/IF {条件}
+- **需求**：系统 SHALL {做什么}
+- **业务规则**：
+  1. {规则1}
+  2. {规则2}
+- **边界条件**：{非正常路径说明}
+- **证据**：[SRC-001] / [CODEMAP:...] / [ASSUMPTION]
+- **AC 引用**：AC-001-1, AC-001-2
+
+#### FR-002：{功能名称}
+
+（同上格式）
+
+---
+
+### 6.3 各端功能详细说明
+
+> 按端展开，每端包含：业务流程 → 关键页面/交互 → 规则与校验 → 接口/数据
+
+#### 6.3.1 管理端
+
+**业务流程**：
+
+```mermaid
+flowchart TD
+    A[开始] --> B{判断条件}
+    B -->|是| C[执行操作]
+    B -->|否| D[另一操作]
+    C --> E[结束]
+    D --> E
+```
+
+**关键页面/交互**：
+
+| 页面/组件 | 说明 | 关键字段/操作 |
+|---|---|---|
+| 列表页 | | |
+| 创建页 | | |
+| 详情页 | | |
+
+**规则与校验**：
+1. {校验规则}
+
+**接口/数据**：
+- 涉及接口：{接口名称}
+- 字段说明：参见第 7 章
+
+---
+
+## 7. 数据与埋点
+
+### 7.1 数据模型（建议结构）
+
+> 新建表或字段变更的建议结构，供技术方参考。
+
+```sql
+-- 新建表示例
+CREATE TABLE `{表名}` (
+  `id`          BIGINT      NOT NULL AUTO_INCREMENT  COMMENT '主键',
+  `code`        VARCHAR(64) NOT NULL                 COMMENT '编号',
+  -- 业务字段...
+  `status`      TINYINT     NOT NULL DEFAULT 0       COMMENT '状态：0=xxx，1=xxx',
+  `create_by`   VARCHAR(64)                          COMMENT '创建人',
+  `create_time` DATETIME                             COMMENT '创建时间',
+  `update_by`   VARCHAR(64)                          COMMENT '更新人',
+  `update_time` DATETIME                             COMMENT '更新时间',
+  `del_flag`    CHAR(1)     NOT NULL DEFAULT '0'     COMMENT '删除标志',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='';
+```
+
+### 7.2 字段定义
+
+| 字段名 | 类型 | 取值/范围 | 说明 | 来源 |
+|---|---|---|---|---|
+| | | | | |
+
+### 7.3 数据口径
+
+| 指标名 | 计算方式 | 来源表/字段 | 备注 |
+|---|---|---|---|
+| | | | |
+
+### 7.4 统计/埋点需求
+
+| 事件名 | 触发时机 | 携带参数 | 用途 |
+|---|---|---|---|
+| | | | |
+
+### 7.5 导出/对账口径
+
+| 字段 | 页面展示 | 导出字段 | 对账字段 | 差异说明 |
+|---|---|---|---|---|
+| | | | | |
+
+---
+
+## 8. 差异点清单（强制）
+
+> 记录"现状 vs 目标"的差异，避免只写方案不写差异。
+
+| 维度 | 现状 | 目标 | 影响范围 | 涉及 FR | 证据 |
+|---|---|---|---|---|---|
+| 策略差异 | | | | | |
+| 口径差异 | | | | | |
+| UI/交互差异 | | | | | |
+| 数据结构差异 | | | | | |
+| 权限差异 | | | | | |
+
+---
+
+## 9. 风险确认与应对
+
+| 风险编号 | 风险描述 | 类型 | 等级 | 应对措施 | 负责人 |
+|---|---|---|---|---|---|
+| R-001 | | 合规/业务/技术/体验 | 高/中/低 | | |
+
+### 9.1 回滚/灰度策略
+
+---
+
+## 10. 里程碑与发布计划
+
+| 里程碑 | 交付物 | 时间 | 负责方 | 状态 |
+|---|---|---|---|---|
+| M0-需求确认 | PRD Final | | PM | |
+| M1-架构设计 | 架构文档 | | Arch | |
+| M2-开发完成 | 代码+单测 | | Dev | |
+| M3-测试通过 | 测试报告 | | QA | |
+| M4-上线 | 发布说明 | | DevOps | |
+
+### 10.1 上线策略与验收标准
+
+---
+
+## 11. 其他需求 / 备注
+
+### 11.1 重要决策记录
+> 可引用 `decision_log.md`
+
+### 11.2 待后续决策事项
+
+---
+
+## 12. 证据映射表（强制）
+
+| 章节 | 关键结论 | 证据 | 状态 |
+|---|---|---|---|
+| 业务背景 | | | |
+| 方案介绍 | | | |
+| 功能需求 | | | |
+| 数据与口径 | | | |
+| 风险 | | | |
+
+---
+
+## 13. FR → AC 覆盖矩阵（强制）
+
+| FR 编号 | FR 标题 | AC 数量 | AC 列表 | 覆盖状态 |
+|---|---|---|---|---|
+| FR-001 | | 2 | AC-001-1, AC-001-2 | ✅ 已覆盖 |
+| FR-002 | | 0 | — | ⚠️ 待补充 |
+
+---
+
+## 14. 系统资产引用（强制）
+
+| 资产类型 | 路径 | 用途 |
+|---|---|---|
+| CodeMap | | |
+| DomainMap | | |
+| Runtime | | |
+
+---
+
+## 15. 参考资料与索引
+
+- 来源索引：见 `materials_index.md`
+- CODEMAP/DOMAINMAP/RUNTIME 引用：见第 14 章
+
+---
+
+## 图表要求（强制检查）
+
+- [ ] 至少 1 个 mermaid 图（流程图/时序图/状态图任选）
+- [ ] 至少 1 张表（范围清单/风险列表/需求拆解等）
+- [ ] 端覆盖矩阵已填写（第 6.1 节）
+- [ ] 差异点清单已填写（第 8 章）
+- [ ] FR→AC 覆盖矩阵已填写（第 13 章）