10 KiB
10 KiB
hyb-oa 文档索引
文档状态：当前人工审查入口。 适用时间：2026-05-09 之后。
本索引用来区分“当前事实源”和“历史证据”。查需求、排期、开发范围时，先读当前事实源；排查历史实现、回归证据或旧决策时，再读历史快照和证据文档。
归档判定规则
本仓库采用“索引归档”策略治理历史文档：历史证据和过期口径保留原路径，不移动到 docs/archive，不批量删除，也不回写旧 Issue CSV。归档通过本文档分区和文档顶部状态说明完成。
| 分类 | 判定标准 | 使用规则 |
|---|---|---|
| 当前事实源 | PRD、模块规约、产品口径、设计规则、AGENTS 项目规则 | 可以直接指导需求确认、Issue CSV 拆分、开发和验收 |
| 当前操作手册 | 管理员、员工、试运行、部署和真机复核手册 | 用于当前试运行、上线和人工验收；与 PRD 冲突时以 PRD 和最新 Issue CSV 为准 |
| 历史证据 | 实现状态矩阵、trialrun 报告和 CSV、旧 TODO、旧实施计划 | 只用于追溯功能是否做过、当时怎么验过；不作为当前需求来源 |
| 技术参考 | 架构、集成边界、领域事件、MCP、ops、ADR | 用于理解运行时边界和技术约束；不能单独扩大当前 MVP 范围 |
| 历史归档参考 | 一次性方案、早期选型、迁移映射和外部调研快照 | 只作审计和追溯；若要重新启用，必须先更新 PRD 或模块规约并新建 Issue CSV |
判断冲突时，优先级固定为：最新 Issue CSV > 当前 PRD 和模块规约 > 产品口径文档 > 当前操作手册 > 技术参考 > 历史证据和归档参考。
当前事实源
| 文档 | 用途 | 注意 |
|---|---|---|
| 海音达OA-MVP需求规格说明书 | 当前 PRD 主事实源，回答做什么、先做什么、不做什么、如何验收，并固定标准软件开发流程 | 后续需求变更先改这里或对应规则文档，再拆 Issue CSV |
| 需求 - 统一审批中心规约 | 统一审批中心模块级开发规约，包含审批规则矩阵、状态流转和权限数据范围 | 审批相关开发拆 Issue CSV 前必须参考 |
| 需求 - 报销发票 OCR 规约 | 报销、发票、OCR、附件、付款和导出模块级开发规约，包含费用类型矩阵、人工复核和验收数据集 | 报销主链路开发拆 Issue CSV 前必须参考 |
| 需求 - 企业微信基础设施规约 | 企业微信入口、免登/绑定、通讯录身份、消息通知、deeplink 和打卡采集边界规约 | 企业微信相关开发拆 Issue CSV 前必须参考 |
| 需求 - 请假考勤修正规约 | 请假、补卡、外出、加班与考勤修正模块级开发规约 | 考勤修正相关开发拆 Issue CSV 前必须参考 |
| 需求 - 采购费用审批规约 | 采购申请、费用申请、供应商、金额、项目、附件、审批规则和业务关联模块级开发规约 | 采购/费用相关开发拆 Issue CSV 前必须参考 |
| 需求 - 合同附件归档规约 | 合同台账、编号、非涉密附件、归档位置、权限审计和业务关联模块级开发规约 | 合同与附件归档相关开发拆 Issue CSV 前必须参考 |
| 需求 - 项目轻管理规约 | 项目基础信息、成员、里程碑、任务、风险、交付记录和业务关联模块级开发规约 | 项目轻管理相关开发拆 Issue CSV 前必须参考 |
| 产品口径文档 | 已拍板的产品边界和业务规则 | 与 PRD 冲突时，以更新后的 PRD 和最新 Issue CSV 为准 |
| 报销、发票与附件规则 | 报销、发票、OCR、附件的细则 | 报销相关开发必须同时参考 |
| 产品设计规则基线 | PC、移动、企业微信 WebView 的视觉和交互规则 | 页面调整必须参考 |
| 测试规约与回归门禁 | 当前测试事实源，固定自动化、视觉验证、真机 smoke、SKIP 和状态回填规则 | A3-A8 开发和后续非微小改动必须参考 |
| 开发交付与变更管理规约 | 当前开发交付事实源，固定 Issue 生命周期、review、commit、工作区和完成输出规则 | 提交和交付前必须参考 |
| AGENTS 项目规则 | Agent 协作、Issue CSV、测试和提交规则 | 执行开发前必须遵守 |
当前操作手册
| 文档 | 用途 | 注意 |
|---|---|---|
| 管理员手册 | 管理员上线、企业微信入口、权限、试点配置 | 适合小团队试运行 |
| 员工快速上手 | 员工侧日常使用说明 | 面向普通员工 |
| 试运行与自动化验证 Runbook | 本地、公网、企业微信试运行操作 | 涉及公网或企业微信真机时必须看 |
| 发布试运行准备清单 | 发布候选证据、权限直连审计、部署预检、live smoke 和小范围试运行顺序 | 从本地可回归进入公网/真机验收前必须看 |
| 公网 live smoke 与真实 OCR 准备清单 | 公网、真实 OCR、企业微信入口复核准备 | 只有部署后才能给出真机验收结论 |
| 真机公网测试清单 | 手机、企业微信、PDF 发票上传人工验证 | 用于上线前人工验收 |
实现状态与证据
| 文档 | 用途 | 注意 |
|---|---|---|
| 实现状态矩阵 | 历史实现状态、完成证据、回归覆盖追踪 | 历史证据，不是 PRD，不作为新增需求来源 |
| 试运行覆盖矩阵 | 试运行覆盖范围和缺口 | 历史证据；读取时结合最新 Issue CSV，不单独决定当前范围 |
| 项目级流程矩阵 | 核心业务流、入口、测试覆盖映射 | 历史证据和 QA 参考，不作为当前需求来源 |
| 人工业务试运行报告 | R70 当时的人工试运行证据 | 历史快照，不代表当前公网状态 |
| 历史 TODO 清账映射 | 旧 TODO 的 implemented / superseded / still-open 追溯 | 历史证据，不用来生成新需求 |
架构、集成与运维参考
| 文档 | 用途 | 注意 |
|---|---|---|
| 系统架构概览 | 当前架构、部署视图和运行时边界 | 与部署现状有关时需结合最新部署报告 |
| 集成边界冻结 | ERP、IM、AI、MCP、PWA 等集成边界 | 技术参考和历史证据；当前首批路线不接入飞书/钉钉，不因本文档扩大 ERP/AI 范围 |
| 领域事件清单 | 领域事件名和对外事件边界 | 技术参考和历史证据；面向集成和异步处理，不作为当前 MVP 扩围依据 |
| MCP Tools | MCP 工具启用边界 | 未启用的 MCP 不得假设可用 |
| 非功能基线 | 安全、性能、回滚、上线最低要求 | 上线和发布前参考 |
| 测试策略 | 自动化测试和门禁策略 | QA 规划参考 |
| Agent 交付实践 | Agent 协作开发、Issue CSV、验证和提交实践 | 与 PRD 第 2 章的软件开发流程配套阅读 |
历史快照与归档参考
| 文档 | 用途 | 注意 |
|---|---|---|
| 实施计划 | 2026-02 Phase 1 引导计划和历史实施思路 | 历史归档参考，不是当前执行计划 |
| 技术栈与复用报告 | 早期技术选型定案和复用说明 | 历史归档参考；技术栈仍有参考价值，范围说明已过时 |
| invoicePool 路由拆分方案 | 一次性拆分方案归档 | 历史归档参考，完成后只作追溯 |
| 试点迁移映射清单 | 旧系统迁移和切换边界 | 历史归档参考，仅在迁移/切换专项中使用 |
| 国内 OA 与费控系统最佳实践对照 | 外部最佳实践调研快照 | 历史归档参考，不替代当前 PRD |
| ADR: 移动端路线决策 | PWA、RN、小程序路线决策记录 | 保留 ADR 历史结论 |
| ADR: 企业卡/虚拟卡管控能力预研 | 企业卡能力预研记录 | 不进入当前 MVP 首批范围 |
阅读顺序
- 要看“现在到底做什么”：读 海音达OA-MVP需求规格说明书。
- 要细化审批、报销、企业微信、考勤修正、采购费用、合同归档或项目轻管理开发任务：读对应模块规约，再拆
issues/*.csv。 - 要开新开发任务：先读 PRD 第 2 章的软件开发项目流程，再更新需求或规则文档，并新建
issues/*.csv。 - 要看“某个业务规则为什么这么定”：读 产品口径文档 和对应规则文档。
- 要判断测试、视觉验证、SKIP、状态回填和提交规则：读 测试规约与回归门禁 和 开发交付与变更管理规约。
- 要判断功能是否已经做过：读 实现状态矩阵 和最新相关 Issue CSV。
- 要上线或真机验收：读 试运行与自动化验证 Runbook、发布试运行准备清单、live smoke 清单和最新部署结果。
明确废弃或不进入首批
- 飞书路线已废弃，不接入登录、通知、审批、文档或项目管理。
- 企业微信原生审批不作为正式审批流；企业微信只做入口、免登/绑定、通讯录身份、消息通知和打卡原始采集。
- 钉钉、小程序、复杂 BPM、重型项目管理、CRM、完整 ERP 不进入当前 MVP 首批范围。