learning-backup

组织人事管理系统(OrgHR)· 规划文档库

全栈考核项目 —— 基于人力资源系统的「组织人事模块」设计与开发

版本 v0.1 | 创建 2026-06-10 | 最后编辑 2026-06-10 | 状态 草稿 | 作者 XXX

本目录是项目的过程性文档库。所有规划、设计、技术方案均沉淀于此,按编号递进阅读。 原始需求见 requirements.md只读,不可编辑),本库其余文档均为对该需求的拆解与落地方案。


一、文档索引

编号 文档 内容摘要 版本 最后编辑 状态
requirements.md 原始考核需求(只读基线) 锁定
00 00-overview.md 总体方案:目标、范围、交付物、里程碑、技术选型摘要 v0.2 2026-06-10 草稿
01 01-product-design.md 产品设计:角色、信息架构、10 大功能域拆解、核心流程、权限 v0.1 2026-06-10 草稿
02 02-architecture.md 技术架构:仓库总览、系统/部署/目录结构、横切关注 v0.3 2026-06-10 草稿
03 03-data-model.md 数据模型:ER 图、核心表设计、migrations 规划 v0.1 2026-06-10 草稿
04 04-api-design.md API 设计:统一约定、分模块端点清单、错误码 v0.2 2026-06-10 草稿
05 05-ui-design.md 视觉与交互设计:设计方向(huashu-design)、设计 token、原型清单 v0.1 2026-06-10 草稿
06 06-roadmap.md 开发计划:实施进度快照、WBS、优先级、排期、风险、测试、上线 v0.3 2026-06-10 草稿
07 07-engineering-standards.md 工程规范:编码、Git、提交、Definition of Done v0.2 2026-06-10 草稿
slides/ Slidev 演示稿(用于汇报过程性文档) v0.1 2026-06-10 草稿

阅读顺序建议:先看 00 建立全局认知 → 01 理解做什么 → 02/03/04 理解怎么做 → 05 看长什么样 → 06/07 看怎么推进与协作。


二、文档规约

  1. requirements.md 只读:作为不可变基线,任何变更只在本库其它文档中以「对需求的解读 / 扩展」形式体现。
  2. 版本与时间:每篇文档头部带元信息行(版本 / 创建 / 最后编辑 / 状态 / 作者),底部带「变更记录」表。每次实质性修改都需 bump 版本号并追加一条变更记录。
    • 版本号规则:v<major>.<minor>minor 用于增量补充,major 用于结构性重写或评审定稿(v1.0 = 首次定稿)。
    • 状态流转:草稿 → 评审中 → 已定稿(vX.0)→ 维护
  3. 单一事实源(SSOT):数据结构以 03-data-model.md 为准,接口以 04-api-design.md 为准,二者冲突时以数据模型为基础对齐 API;产品口径以 01-product-design.md 为准。
  4. 可追溯:每个功能域在 01 有需求定义、在 03 有数据落点、在 04 有接口、在 06 有任务与验收,形成「需求→设计→实现→验收」闭环。
  5. 命名:文档用中文叙述,标识符(表名/字段/接口/枚举)用英文 snake_case,与代码保持一致。

三、全局变更记录

日期 版本 变更 作者
2026-06-10 v0.1 建立文档库骨架,产出 00–07 全套规划初稿与 Slidev 演示骨架 XXX
2026-06-10 后端 M1 落地(server/,Go+Gin+Bun+PG,可运行已自测);启动方式统一为 mise 任务,相关文档(00/02/07)升 v0.2 XXX
2026-06-10 后端落地入离调转审批闭环 + 统计看板接口;文档对齐实现(02 补仓库总览 v0.3、04 路由对齐 v0.2、06 进度快照 v0.2) XXX

四、关键事实速查