文档归档:迁移原始材料与历史设计至docs/archive
This commit is contained in:
1 parent
e62904a853
commit
f7db7b592c
21 files changed
+129
-62
No files matched your search
@@ -1,52 +0,0 @@
|
||||
# RailwaySystem 业务与产品需求文档中心(doc)
|
||||
|
||||
> **最高基线声明**:当前系统一期唯一正式冻结并生效的业务需求基线为根目录下的 [RailwaySystem 智慧培训系统一期 PRD V1.0.md](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md)。
|
||||
> 所有开发、测试、数据库建模与功能验收工作,均严格以 **PRD V1.0** 为最终判定依据。
|
||||
|
||||
---
|
||||
|
||||
## 目录组织架构
|
||||
|
||||
```text
|
||||
doc/
|
||||
├── README.md # 【本文件】产品与业务需求中心全景导览
|
||||
├── RailwaySystem 智慧培训系统一期 PRD V1.0.md # ★★★ 当前唯一正式生效的一期业务需求基线(已冻结)
|
||||
├── raw_materials/ # 甲方原始交付需求与设计资料
|
||||
│ ├── README.md # 原始材料目录说明
|
||||
│ ├── 学员管理系统功能分析_20260831.docx / .md # 原始功能拆解与菜单规划初稿
|
||||
│ ├── 学员管理系统数据表设计_20260907_1_.docx / .md # 原始14张培训业务表设计草案
|
||||
│ └── 学员管理系统相关需求.docx / .md # 原始学员培训与教务综合需求
|
||||
├── archive/ # 历史演进过程稿与讨论底稿归档
|
||||
│ ├── README.md # 历史归档说明
|
||||
│ ├── RailwaySystem 智慧培训系统一期 PRD V0.9.md # 一期 PRD 历史讨论稿(上一版草案)
|
||||
│ ├── RailwaySystem 一期 P0 需求确认表 V0.1.md # 早期核心优先级对齐清单
|
||||
│ ├── RailwaySystem 一期需求分析与业务基线 V0.1.md # 早期需求分析报告
|
||||
│ └── RailwaySystem 一期默认开发决策与需求假设 V0.1.md # 早期技术假设与边界推演
|
||||
└── wxy_doc/ # 早期技术原型与设计说明(仅作技术演进参考)
|
||||
├── README.md # 目录说明
|
||||
├── 智慧培训系统一期详细开发说明书.md # 早期技术说明草案(暂不使用)
|
||||
├── railwaysystem.html # 基于 ELK 的系统拓扑可视化原型
|
||||
└── elk.bundled.js # 拓扑可视化依赖 JS 引擎
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 核心业务基线速览(PRD V1.0)
|
||||
|
||||
详细业务规范请完整阅读 [RailwaySystem 智慧培训系统一期 PRD V1.0.md](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md),主要核心域包括:
|
||||
|
||||
| 业务域 | 涉及核心对象 | 关键业务规则与一期边界 | PRD 对应章节 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **基础信息** | 教师、学员、课程 | 学员身份证国密/SM4加密存储与脱敏;课程支持一期基础属性,不做多版本与审批流 | 第 5、6、7 章 |
|
||||
| **教学资源** | 教室、实训场地、电子班牌 | 支持资源状态流转;电子班牌支持与教室、课次绑定及日程轮播展示 | 第 8、9、10 章 |
|
||||
| **培训与教务** | 开班计划、开班课程、课次、参训学员 | **开班计划支持多门课程**;排课细化到具体课次;明确独立的班级—学员参训关系 | 第 11、12、13、14 章 |
|
||||
| **报到与考勤** | 开班报到、课次考勤、学习记录 | 区分班级报到与具体课次考勤;考勤记录精确关联到课次;记录学员自学与实训时长 | 第 15、16、17 章 |
|
||||
| **生活后勤** | 宿舍楼栋、房间、床位、门禁授权 | **房间与床位拆分**为两级模型;**住宿事实与门禁权限解耦**,支持按床位安排并独立下发门禁授权 | 第 18、19、20 章 |
|
||||
| **考核与画像** | 成绩科目/权重、学员得分、综合画像 | 彻底摒弃固定三列成绩,支持**动态成绩科目与权重**;多维雷达图与基础能力画像分析 | 第 21、22、23 章 |
|
||||
|
||||
---
|
||||
|
||||
## 业务与技术文档的对应关系
|
||||
|
||||
- **业务需求中心 (`doc/`)**:定义**系统应该做什么、业务对象是什么、业务规则与输入输出约束**。
|
||||
- **技术审计中心 (`docs/`)**:技术人员请参阅 [docs/README.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/README.md) 及 [docs/codebase-audit/](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/),获取当前工程架构、14张历史业务表与PRD差异对比([14_database_code_diff.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/14_database_code_diff.md))、KingbaseES 实测兼容性等技术事实。
|
||||
File renamed without changes.
@@ -0,0 +1,93 @@
|
||||
# SYFJGYD学员管理系统 — 历史资料归档中心 (Archive)
|
||||
|
||||
> **历史归档声明 (HISTORICAL REFERENCE)**:
|
||||
> 本目录归档存放项目启动与早期研发阶段的**甲方原始资料、早期需求草案、早期技术原型与历史数据库设计稿**。
|
||||
> 本目录所有内容仅供溯源、审计与沿革参考,**不作为当前系统实现的验收依据**。
|
||||
>
|
||||
> - **当前一期正式生效业务基线**:[docs/requirements/一期PRD-V1.0.md](../requirements/一期PRD-V1.0.md)
|
||||
> - **当前数据库物理结构事实源**:[docs/database-v2/](../database-v2/01_table_inventory.md) 与 `RuoYi-Vue/sql/train/v2/`
|
||||
> - **当前系统运行与试用现状**:[docs/current/](../current/README.md)
|
||||
|
||||
---
|
||||
|
||||
## 🧭 历史资料组织架构
|
||||
|
||||
```text
|
||||
docs/archive/
|
||||
├── README.md # 【本文件】统一历史资料归档入口全景导览
|
||||
├── raw-materials/ # 甲方原始交付需求、功能分析与初版数据表设计(docx / md 原件)
|
||||
├── requirements-history/ # 需求演进过程稿(PRD V0.9、V0.1 调研表、业务基线草案)
|
||||
├── legacy-design/ # 早期技术原型资料(详细开发说明书草案、ELK 拓扑原型)
|
||||
└── database-history/ # 历史数据库设计资料(Kingbase DDL 规范草稿)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📂 归档子目录职责与清单
|
||||
|
||||
### 1. 甲方原始资料:`raw-materials/`
|
||||
- **定位**:项目启动阶段业务方提供的原始需求文件、功能模块初稿与初始 14 张表设计草案。
|
||||
- **清单**:
|
||||
- `学员管理系统相关需求.docx` / `.md`:业务方最初提出的学员、班级、住宿、培训宏观需求与业务设想;
|
||||
- `学员管理系统功能分析_20260831.docx` / `.md`:培训系统功能模块拆解、业务流梳理与菜单原型规划初稿;
|
||||
- `学员管理系统数据表设计_20260907_1_.docx` / `.md`:早期数据库 14 张培训业务表设计草案;
|
||||
- `README.md`:原始交付材料说明与演变提示。
|
||||
- **演变关系**:所有有效需求已提炼至 [一期PRD-V1.0.md](../requirements/一期PRD-V1.0.md),表结构差异详见 [14_database_code_diff.md](../codebase-audit/14_database_code_diff.md)。
|
||||
|
||||
### 2. 早期需求草案:`requirements-history/`
|
||||
- **定位**:需求演进与讨论过程中的中间草稿,用于追溯决策依据。
|
||||
- **清单**:
|
||||
- `RailwaySystem 智慧培训系统一期 PRD V0.9.md`:一期产品需求讨论草案(已升级为 V1.0);
|
||||
- `RailwaySystem 一期 P0 需求确认表 V0.1.md`:核心功能优先级(P0/P1/P2)研讨与业务确认清单;
|
||||
- `RailwaySystem 一期需求分析与业务基线 V0.1.md`:面向业务方需求的初步分析与功能点映射草稿;
|
||||
- `RailwaySystem 一期默认开发决策与需求假设 V0.1.md`:早期针对甲供资料不完备部分制定的默认技术假设;
|
||||
- `README.md`:历史版本归档清单与核心演进对比。
|
||||
|
||||
### 3. 早期技术原型:`legacy-design/`
|
||||
- **定位**:早期编写的系统设计与前端拓扑可视化原型(HISTORICAL REFERENCE)。
|
||||
- **清单**:
|
||||
- `智慧培训系统一期详细开发说明书.md`:早期技术说明草案(基于旧数据表与旧需求);
|
||||
- `railwaysystem.html`:基于 ELK 布局引擎生成的培训系统架构与业务拓扑可视化原型;
|
||||
- `elk.bundled.js`:前端拓扑布局引擎打包库;
|
||||
- `README.md`:早期技术原型归档说明。
|
||||
|
||||
### 4. 旧数据库设计:`database-history/`
|
||||
- **定位**:数据库建模阶段的历史设计冻结稿,供追溯字段设计思路。
|
||||
- **清单**:
|
||||
- `RailwaySystem 数据库 V2 字段设计与 Kingbase DDL 规范 V1.0.md`:早期 21 张表字段与 DDL 设计草案;
|
||||
- `README.md`:明确该文档为历史设计资料,物理事实源已迁移至 `docs/database-v2/`。
|
||||
|
||||
---
|
||||
|
||||
## 📌 业务与技术演进对照
|
||||
|
||||
| 历史资料分类 | 对应历史文档 | 当前生效的正式替代入口 | 核心差异说明 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **正式业务需求** | `requirements-history/PRD V0.9` | [**docs/requirements/一期PRD-V1.0.md**](../requirements/一期PRD-V1.0.md) | V1.0 厘清了多对多开班课程、课次、床位与门禁解耦、动态成绩模型等关键规则。 |
|
||||
| **需求实现跟踪** | `requirements-history/P0确认表` | [**docs/requirements/一期需求实现进度表.md**](../requirements/一期需求实现进度表.md) | 当前进度表具备逐项前后端源码、数据库表与 331 项测试断言证据。 |
|
||||
| **待确认事项** | `raw-materials/相关需求` | [**docs/requirements/甲方需求确认清单.md**](../requirements/甲方需求确认清单.md) | 当前清单聚焦 P0/P1/P2 精准业务阻塞项,用于与段方对齐。 |
|
||||
| **数据库物理表** | `database-history/DDL规范` | [**docs/database-v2/01_table_inventory.md**](../database-v2/01_table_inventory.md) | 当前金仓物理表结构及初始化脚本位于 `RuoYi-Vue/sql/train/v2/`。 |
|
||||
| **系统架构与指南** | `legacy-design/详细开发说明书` | [**docs/handbook/01-project-overview.md**](../handbook/01-project-overview.md) | 当前团队手册完整涵盖项目总览、业务流、架构设计、数据模型与开发规范。 |
|
||||
|
||||
---
|
||||
|
||||
## 核心业务基线速览(PRD V1.0)
|
||||
|
||||
详细业务规范请完整阅读 [一期PRD-V1.0.md](../requirements/一期PRD-V1.0.md),主要核心域包括:
|
||||
|
||||
| 业务域 | 涉及核心对象 | 关键业务规则与一期边界 | PRD 对应章节 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **基础信息** | 教师、学员、课程 | 学员身份证国密/SM4加密存储与脱敏;课程支持一期基础属性,不做多版本与审批流 | 第 5、6、7 章 |
|
||||
| **教学资源** | 教室、实训场地、电子班牌 | 支持资源状态流转;电子班牌支持与教室、课次绑定及日程轮播展示 | 第 8、9、10 章 |
|
||||
| **培训与教务** | 开班计划、开班课程、课次、参训学员 | **开班计划支持多门课程**;排课细化到具体课次;明确独立的班级—学员参训关系 | 第 11、12、13、14 章 |
|
||||
| **报到与考勤** | 开班报到、课次考勤、学习记录 | 区分班级报到与具体课次考勤;考勤记录精确关联到课次;记录学员自学与实训时长 | 第 15、16、17 章 |
|
||||
| **生活后勤** | 宿舍楼栋、房间、床位、门禁授权 | **房间与床位拆分**为两级模型;**住宿事实与门禁权限解耦**,支持按床位安排并独立下发门禁授权 | 第 18、19、20 章 |
|
||||
| **考核与画像** | 成绩科目/权重、学员得分、综合画像 | 彻底摒弃固定三列成绩,支持**动态成绩科目与权重**;多维雷达图与基础能力画像分析 | 第 21、22、23 章 |
|
||||
|
||||
---
|
||||
|
||||
## 业务与技术文档的对应关系
|
||||
|
||||
- **历史资料中心 (`docs/archive/`)**:归档早期交付材料、讨论稿与旧设计。
|
||||
- **业务需求中心 (`docs/requirements/`)**:定义**系统应该做什么、业务对象是什么、业务规则与输入输出约束**。
|
||||
- **技术审计中心 (`docs/`)**:技术人员请参阅 [docs/README.md](../README.md) 及 [docs/codebase-audit/](../codebase-audit/),获取当前工程架构、14张历史业务表与PRD差异对比([14_database_code_diff.md](../codebase-audit/14_database_code_diff.md))、KingbaseES 实测兼容性等技术事实。
|
||||
@@ -0,0 +1,24 @@
|
||||
# 历史数据库设计资料归档 (database-history)
|
||||
|
||||
> **历史归档声明 (HISTORICAL REFERENCE)**:
|
||||
> 本目录下的 [`RailwaySystem 数据库 V2 字段设计与 Kingbase DDL 规范 V1.0.md`](RailwaySystem%20数据库%20V2%20字段设计与%20Kingbase%20DDL%20规范%20V1.0.md) 是数据库建模阶段的历史设计资料,仅供追溯设计演变与字段初衷参考。
|
||||
> **不得作为当前数据库物理结构与迁移的判定依据**。
|
||||
|
||||
---
|
||||
|
||||
## 🗄️ 当前真实数据库事实源
|
||||
|
||||
如需查阅当前系统正在使用的真实国产人大金仓(KingbaseES)物理表结构、字段定义、外键约束、索引以及 DDL 脚本,请务必以以下两处为唯一权威事实源:
|
||||
|
||||
1. **结构设计与字段字典**:[**docs/database-v2/01_table_inventory.md**](../../database-v2/01_table_inventory.md)
|
||||
(包含 21 张物理表字段清单、类型映射规范与索引说明);
|
||||
2. **可执行 DDL 生产脚本**:[`RuoYi-Vue/sql/train/v2/`](../../../RuoYi-Vue/sql/train/v2/)
|
||||
(包含当前集成验收库与共享试用库所执行的最终物理表结构初始化 SQL)。
|
||||
|
||||
---
|
||||
|
||||
## 📋 包含的历史设计文件
|
||||
|
||||
| 文档名称 | 原始版本 | 性质说明 |
|
||||
| :--- | :--- | :--- |
|
||||
| [`RailwaySystem 数据库 V2 字段设计与 Kingbase DDL 规范 V1.0.md`](RailwaySystem%20数据库%20V2%20字段设计与%20Kingbase%20DDL%20规范%20V1.0.md) | V1.0 (冻结设计稿) | 早期 21 张培训业务表字段设计草案与 Kingbase DDL 理论规范 |
|
||||
File renamed without changes.
@@ -1,7 +1,9 @@
|
||||
# 早期技术参考资料(wxy_doc)
|
||||
# 早期技术与原型设计资料归档 (legacy-design)
|
||||
|
||||
> **状态说明**:本目录为王杏月师姐早期编写的系统设计与前端拓扑可视化原型资料。**仅供技术演进与历史设计参考,不作为系统一期正式业务与实现基线**。
|
||||
> 一期最新最高业务基线请以根目录 [PRD V1.0](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md) 为准。
|
||||
> **历史归档声明 (HISTORICAL REFERENCE)**:
|
||||
> 本目录归档存放王杏月师姐早期编写的系统设计与前端拓扑可视化原型资料。
|
||||
> **仅供技术演进与历史设计参考,不作为系统一期正式业务与实现基线**。
|
||||
> 一期最新最高业务基线请参见:[docs/requirements/一期PRD-V1.0.md](../../requirements/一期PRD-V1.0.md)。
|
||||
|
||||
---
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,8 +1,8 @@
|
||||
# 甲方原始交付需求与设计资料(raw_materials)
|
||||
# 甲方原始交付需求与设计资料(raw-materials)
|
||||
|
||||
> **说明**:本目录归档存放项目启动与早期阶段甲方/业务方提供的原始需求、功能分析与初版数据表设计文档(包含原始 docx 及同名导出的 markdown 格式)。
|
||||
>
|
||||
> **最高业务基线**:所有原始材料中的要求已全部整合、甄别并提炼至 [RailwaySystem 智慧培训系统一期 PRD V1.0.md](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md)。在需求冲突时,一律以 **PRD V1.0** 为准。
|
||||
>
|
||||
> **最高业务基线**:所有原始材料中的要求已全部整合、甄别并提炼至 [一期PRD-V1.0.md](../../requirements/一期PRD-V1.0.md)。在需求冲突时,一律以 **PRD V1.0** 为准。
|
||||
|
||||
---
|
||||
|
||||
@@ -18,5 +18,5 @@
|
||||
|
||||
## 演进与演变提示
|
||||
|
||||
1. **表结构演进**:`学员管理系统数据表设计_20260907_1_` 中定义的字段与当前生产 KingbaseES 数据库存在部分类型演进(如主键 identity、timestamp 等),且与 PRD V1.0 要求的开班计划—课程、参训关系、课次对象存在结构化演进,详见技术审计文档 [14_database_code_diff.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/14_database_code_diff.md)。
|
||||
1. **表结构演进**:`学员管理系统数据表设计_20260907_1_` 中定义的字段与当前生产 KingbaseES 数据库存在部分类型演进(如主键 identity、timestamp 等),且与 PRD V1.0 要求的开班计划—课程、参训关系、课次对象存在结构化演进,详见技术审计文档 [14_database_code_diff.md](../../codebase-audit/14_database_code_diff.md)。
|
||||
2. **需求演进**:早期需求中模糊的门禁关联、签到联动与成绩结构,已在 PRD V1.0 中建立严格的业务边界定义。
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,8 +1,8 @@
|
||||
# 历史过程稿与版本归档(archive)
|
||||
# 需求演进过程稿与历史版本归档 (requirements-history)
|
||||
|
||||
> **状态说明**:本目录归档存放项目需求梳理与演化过程中的历史中间稿、前期调研确认表及技术假设分析文档。
|
||||
>
|
||||
> **最高业务基线**:当前系统一期唯一正式生效的业务基线为上一层目录中的 [RailwaySystem 智慧培训系统一期 PRD V1.0.md](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md)。本目录下的历史文档已全部被 V1.0 覆盖,仅供版本追溯和决策沿革查询。
|
||||
>
|
||||
> **最高业务基线**:当前系统一期唯一正式生效的业务基线为 [一期PRD-V1.0.md](../../requirements/一期PRD-V1.0.md)。本目录下的历史文档已全部被 V1.0 覆盖,仅供版本追溯和决策沿革查询。
|
||||
|
||||
---
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
Reference in new issue
Block a user