Files
railwaysystem/docs/README.md
T
wangzhibiao 86e07c35e3 文档维护:固化纯净库引导链与三维接口总账
1. 查明空库真正 Bootstrap Chain:明确以 ry_20250522.sql + quartz.sql + 000_phase05_exact_schema.sql 为前置基线;
2. 纠偏 API Inventory 统计指标:确立 107 个端点、0 重复,升级为读写分离物理表调用链 (100% 源码追踪);
3. 明确四类 API 边界:自研业务端点 107、平台端点 95、甲方端点 0、第三方端点 9、纯模拟端点 1;
4. 升级 Client API 状态模型:引入连通性、真实数据与可用性三维矩阵,实证 DMS 0 资源现状,将远程开门更正为 SECURITY_PROHIBITED;
5. 输出纯净演示数据库设计规约草案 (CLEAN_DEMO_DATABASE_SPEC.md)。
2026-09-24 00:18:15 +08:00

105 lines
8.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# SYFJGYD学员管理系统 — 文档中心全景地图 (Docs Map)
> **正式业务名称**:`SYFJGYD学员管理系统`(内部工程代号:RailwaySystem)
> **共享试用环境**:[http://192.168.139.230:8082/](http://192.168.139.230:8082/)(部署分支:`feat/cicd-pipeline`,运行状态请参见 [01-CURRENT-SYSTEM-STATE.md](current/01-CURRENT-SYSTEM-STATE.md))
> **核心质量结论**:核心教务正向闭环全面就绪,三角色工作台验证通过,测试全绿 **331 / 331 PASS**。
---
## 🧭 第一屏直达:按你的目标快速找文档
请直接根据你当下的工作任务,点击下方直达通道:
```text
┌────────────────────────────────────────────────────────────────────────┐
│ 🎯 你当前的目标是? │
├────────────────────────────────────────────────────────────────────────┤
│ 1. 只想快速了解当前系统做到哪了、能不能用? ──► [docs/current/] │
│ 2. 想看一期功能列表、代码对照与甲方确认项? ──► [docs/requirements/] │
│ 3. 想系统学习业务流程、系统架构与操作手册? ──► [docs/handbook/] │
│ 4. 想开发新功能、对接接口或查数据库字段? ──► [docs/contracts/] │
│ (包含 api-v2 / database-v2 / development) │
│ 5. 想给领导、老师或评审专家进行生动展示? ──► [docs/visual/] │
│ 6. 想查阅最终验收报告或历史自动化测试证据? ──► [docs/reports/] │
│ 7. 想查阅甲方原始需求与早期设计演进草案? ──► [docs/archive/] │
└────────────────────────────────────────────────────────────────────────┘
```
---
## 📚 各目录体系深度说明
### 1. 🌟 [docs/current/00-START-HERE.md](current/00-START-HERE.md) — 【唯一首选入口】当前系统现行真理中心
专为人类与 Agent 设立的**唯一权威现行真理门户**,杜绝历史长日志篡权:
- [00-START-HERE.md](current/00-START-HERE.md):**第一入口**(真理优先级声明与全量当前文档导航)
- [01-CURRENT-SYSTEM-STATE.md](current/01-CURRENT-SYSTEM-STATE.md):当前系统真实运行基线、技术栈与工作树状态
- [02-FUNCTION-MODULES.md](current/02-FUNCTION-MODULES.md):业务功能模块全量五级判定 (IMPLEMENTED/PARTIAL/MOCK/BLOCKED_EXTERNAL/NOT_IMPLEMENTED)
- [03-DATABASE-AND-TABLES.md](current/03-DATABASE-AND-TABLES.md):KingbaseES 物理表结构、迁移链与真正建库流水线(附 CLEAN_DEMO_DATABASE_SPEC.md 规约)
- [04-API-INVENTORY.md](current/04-API-INVENTORY.md):全量 API 接口账本(107端点源码级读写调用链、build_ui 视图引用验证与4类接口边界)
- [05-CLIENT-API-STATUS.md](current/05-CLIENT-API-STATUS.md):外部接口状态清单(连通性/数据状态/可用性三维矩阵,DMS 0资源实证与安全禁止声明)
- [06-DEMO-BASELINE.md](current/06-DEMO-BASELINE.md):演示基线准则(旧Demo不可信声明与新Demo确定性构建七大原则)
- [07-KNOWN-GAPS.md](current/07-KNOWN-GAPS.md):内部已知缺口与外部阻塞清单(内部阻断项已清零,仅存外部 DMS 硬件阻塞)
- [08-NEXT-ACTIONS.md](current/08-NEXT-ACTIONS.md):下一阶段标准化 16 步行动路线图
---
### 2. 📋 [docs/requirements/](requirements/README.md) — 业务需求与确认清单
连接业务与代码的正式事实依据:
- [一期PRD-V1.0.md](requirements/一期PRD-V1.0.md):一期系统正式业务需求冻结基线(领域对象、业务规则与输入输出约束)
- [一期需求实现进度表.md](requirements/一期需求实现进度表.md):按模块逐项核对每一条需求的前后端代码实现、页面位置与测试证据
- [甲方需求确认清单.md](requirements/甲方需求确认清单.md):面向沈阳房建公寓段业务老师提炼的待确认分级清单(P0 核心 18 项、P1 细节 12 项、P2 规划 8 项)
---
### 3. 📖 [docs/handbook/](handbook/01-project-overview.md) — 团队操作白皮书与全景指南
面向人类可读的系统级白皮书,涵盖业务、技术与运维全链路:
- [01-project-overview.md](handbook/01-project-overview.md):系统建设背景、业务痛点与角色价值
- [02-business-process.md](handbook/02-business-process.md):核心业务闭环流程与状态机流转规则
- [03-system-architecture.md](handbook/03-system-architecture.md):系统分层架构、核心组件与技术选型
- [04-data-model-overview.md](handbook/04-data-model-overview.md):数据模型概念设计与关键实体关系
- [05-module-guide.md](handbook/05-module-guide.md):14 大业务功能模块使用与代码扩展指南
- [06-api-and-permission-overview.md](handbook/06-api-and-permission-overview.md):接口分类体系与 RBAC 权限矩阵
- [07-testing-and-acceptance.md](handbook/07-testing-and-acceptance.md):测试规范与自动化验证体系
- [08-deployment-and-release.md](handbook/08-deployment-and-release.md):共享试用环境部署拓扑与运维规范
- [09-current-status.md](handbook/09-current-status.md):团队级现状综合看板
---
### 4. 🔒 研发契约与开发规范 (Contracts & Development)
技术人员与智能 Agent 研发的核心事实源(只读冻结):
- **[docs/api-v2/](api-v2/00_readme.md)**:RESTful API 契约总纲、Module A~D 接口规范、DTO/VO 字典与业务错误码
- **[docs/database-v2/](database-v2/01_table_inventory.md)**:国产人大金仓 KingbaseES 物理表清单、索引约束设计与迁移说明
- **[docs/development/](development/git-commit-convention.md)**:
- [git-commit-convention.md](development/git-commit-convention.md):项目 Git 提交中文格式规范
- [dms-r3/](development/dms-r3/00_source_and_scope.md):DMS 智能门禁适配器架构设计与 Token 策略
- [rbac-r2/](development/rbac-r2/00_current_state.md):多角色 RBAC、业务身份绑定与防 IDOR 越权设计
---
### 5. 🖥️ [docs/visual/](visual/index.html) — 数字化离线交付门户
纯静态 HTML + CSS + JS 构建的交互式展示门户,浏览器直接双击打开,适合大屏展示:
- [index.html](visual/index.html):交付门户主页
- [architecture.html](visual/architecture.html):架构与技术栈
- [business-flow.html](visual/business-flow.html):全景业务状态机
- [data-model.html](visual/data-model.html):实体关系 (ER) 与表字典
- [modules.html](visual/modules.html):14 大模块导览
- [testing.html](visual/testing.html):质量与验证体系
- [deployment.html](visual/deployment.html):部署拓扑与 Delta 增量
- [release-status.html](visual/release-status.html):发版进度与门禁看板
---
### 6. 📑 [docs/reports/](reports/README.md) — 质量验收与历史证据
- **当前唯一终验报告**:[FINAL_PHASE1_20260917_101044/](reports/integrated-acceptance/FINAL_PHASE1_20260917_101044/README.md)(含 [执行总摘要](reports/integrated-acceptance/FINAL_PHASE1_20260917_101044/executive-summary.md))
- **过程性测试证据**:Round 1~3B 自动化测试日志、DMS 实测探针、Playwright 无头浏览器运行截图
- **早期归档报告**:[archive/20260915/](reports/archive/20260915/)(已被终检报告全面覆盖的早期旧报告)
---
### 7. 🏛️ [docs/archive/](archive/README.md) — 历史资料归档中心
归档项目启动与早期研发阶段的原始交付与过程资产(HISTORICAL REFERENCE):
- **[raw-materials/](archive/raw-materials/README.md)**:甲方原始交付需求、功能分析与初版数据表设计(docx / md 原件)
- **[requirements-history/](archive/requirements-history/README.md)**:需求演进过程稿(PRD V0.9、V0.1 调研表、业务基线草案)
- **[legacy-design/](archive/legacy-design/README.md)**:早期技术原型资料(详细开发说明书草案、ELK 拓扑原型)
- **[database-history/](archive/database-history/README.md)**:历史数据库设计资料(Kingbase DDL 规范草稿)