# 注释与交付规范 v2.0.0

本规范沿用 `6Q_leader_battalion` 的功能清单与红点注释体系，按「复刻」场景改成五段。

## 1. 功能编号

- 后台：`EX-001` 起，按模块顺序编号。
- H5：`EX-101` 起，按用户链路顺序编号。
- 编号同时是功能清单序号、页面注释 `req`、跳转参数 `note`。

功能清单入口：`6Q_exam_battalion/index.html`。  
H5 功能的入口在后台功能清单的「H5」分组，也可以直接打开 `6Q_exam_h5/index.html`。

## 2. 页面红点

页面上需要解释的元素用：

```html
<button class="ex-dot" data-note-key="template-status" type="button"></button>
```

- `data-note-key` 必须在该页的 `notes` 配置里存在。
- 一个 key 对应一条功能编号；同一页可出现多次。
- 红点只负责打开注释，不执行筛选、提交等真实动作。

## 3. 注释五段

每条注释固定五段，顺序不能变：

1. **过往逻辑 · v2.0.0**  
   上一版（基线）的行为，只写事实。后台引用 `src/views/exam/**`，H5 引用 `exam2.0` 对应页面。
2. **现在的逻辑 · v2.1.0**  
   本次版本做到哪、不做什么、和上一版有什么差异。差异必须写出来，不能默认读者知道。
   基线功能（EX-001~018 / EX-101~117）本条段名写作 `现在的逻辑 · v2.0.0`，不改写内容。
3. **元素表**  
   列：元素名称 / 元素类型 / 是否必填 / 说明。  
   复刻新增标 `new`，逻辑调整标 `Iteration`，其余不打标。
4. **接口**  
   现网接口路径与方法，只作对照，未接后端。
5. **数据流**  
   数据从哪个页面写入、存到哪、在哪个页面被读取；跨端写清楚。

### 示例

```
过往逻辑 · v2.0.0
模板禁用时级联下架测评商品，接口 put exam/exam/templete/shelves。

现在的逻辑 · v2.1.0
列表保留启用/禁用按钮。禁用弹确认框，确认后把该模板关联的商品状态改为下架。
不真实请求接口，结果只写本地 mock。

元素表
状态 | 标签 | 否 | 启用/禁用两态
禁用 | 按钮 | 否 | 二次确认，提示级联下架商品

接口
PUT exam/exam/templete/shelves

数据流
模板列表 → 商品列表：模板 status=2 时，商品 status 同步为 2（下架）。
```

## 4. 功能清单表头

后台功能清单固定列：

| 序号 | 模块 | 功能 | 状态 | 原型 | 说明 |
| --- | --- | --- | --- | --- | --- |

- 状态只用：`done` / `partial` / `todo`
- 原型列必须是可以直接点开的相对链接
- 说明列写边界，不写营销话术

## 5. Spec 交付

每次版本在 `specs/<编号>-<feature>/` 下交齐：

| 文件 | 内容 |
| --- | --- |
| `spec.md` | 用户故事、功能需求、实体、成功标准 |
| `plan.md` | 技术方案、目录结构、阶段拆分 |
| `tasks.md` | 可勾选任务，按阶段分组 |
| `data-model.md` | 实体字段、关系、状态机 |
| `contracts/api.md` | 现网接口与原型 mock 的对应 |
| `research.md` | 源码分析、口径、未决问题 |
| `quickstart.md` | 本地启动与验收路径 |
| `checklist.md` | 交付前逐项检查 |

## 6. 版本与文案

- 版本统一 `v2.0.0`，出现在入口页、后台顶栏、H5 关于页、README、CHANGELOG。
- 页面文案用简体中文；字段名与源码保持一致，不自行改名。
- 原型数据全部为模拟数据，不出现真实手机号、身份证、银行卡。
- 金额统一 `￥`，时间统一 `YYYY-MM-DD HH:mm`，日期统一 `YYYY-MM-DD`。
