Files
railwaysystem/docs/current/00-START-HERE.md
T

6.5 KiB
Raw Blame History

00 - RailwaySystem 现行系统唯一权威真理入口 (Start Here)

SOURCE OF TRUTH PRIORITY

1. docs/current/**
2. current source code / migrations
3. confirmed client requirements
4. current test evidence
5. historical reports

docs/reports/** MUST NOT be treated as current truth.

1. 核心定位与真理唯一性法则

本目录(docs/current/)是 SYFJGYD学员管理系统(内部工程代号:RailwaySystem)面向所有研发人员、测试工程师、交付团队、管理人员以及 AI 智能体 (Agent) 的唯一权威真理中心。

在过去多轮并行迭代与验证过程中,项目沉淀了大量历史测试、审计与阶段报告(存放于 docs/reports/**)。为防止历史快照篡权和事实失真,确立以下不可动摇的法则:

  1. 真理优先级铁律:如首屏声明,docs/current/** 拥有最高文档解释权,任何 docs/reports/** 下的历史报告仅作为时间序列凭证,绝对不得覆盖本目录所载明的当前事实。
  2. 唯一入口导航:人类读者与 Agent 接手任务时,必须以本文件为第一入口,禁止直接引用散落在历史报告中的过期结论。
  3. 实事求是原则:所有现状描述直接锚定底层 Git HEAD 代码与 Kingbase 物理迁移,严禁虚报、浮夸或把未实现能力写为已完成。
  4. 代码真源权威原则:
    • 前端唯一构建与部署真源:build_ui/(RuoYi-Vue/ruoyi-ui 仅为历史非活跃归档备份,非构建源、非部署源);
    • 后端源码真源:RuoYi-Vue/(Spring Boot 2.5.15 / Java 8);
    • 数据库 DDL 权威:RuoYi-Vue/sql/train/v2/ 与 RuoYi-Vue/sql/system/kingbase/ 迁移脚本链。

2. 系统核心标识与运行基线

  • 正式业务名称:SYFJGYD学员管理系统
  • 内部工程代号:RailwaySystem
  • 当前开发分支:fix/phase0-product-defects-20260923
  • 共享试用部署分支:feat/cicd-pipeline
  • 共享试用访问地址:http://192.168.139.230:8082/
  • 数据库系统:国产人大金仓 KingbaseES V9 (schema: public, 共享试用库: training)
  • 当前试用就绪度:READY_WITH_EXTERNAL_BLOCKERS(核心教务主闭环打通,内部 P0 阻断清零;外部智能门锁硬件因无资源处于客观阻塞)

3. Current 权威文档中心导航表

本目录现行收录且仅收录以下 8 份相互解耦、权责明确的真理文档:

编号 文档名称 核心职责与回答的关键问题 适用对象
01 01-CURRENT-SYSTEM-STATE.md 系统当前真实状态速览
Git基线、前端源码真源 (build_ui/)、后端源码、部署状态、阻断项(ACCOM-PERM-01已解决)、活跃Worktree、Demo状态与文档状态。
全体成员、新接手人员、Agent
02 02-FUNCTION-MODULES.md 业务功能模块全量判定
按教师、学员、课程、场地、计划、排课、考勤、住宿、成绩、统计、DMS等逐项给出五级状态判定。
产品经理、业务主管、交付验收
03 03-DATABASE-AND-TABLES.md 数据库架构、迁移链与数据表总账
KingbaseES DDL、21张业务表、系统表、真正可重复建库流水线说明(附设计规约草案 CLEAN_DEMO_DATABASE_SPEC.md)。
后端开发、DBA、数据审计人员
04 04-API-INVENTORY.md 全量 API 接口总账
全量后端 Controller 接口路径、HTTP 方法、源码级校验表关联、build_ui 实际调用关系与实现状态。
前后端研发、接口自动化测试
05 05-CLIENT-API-STATUS.md 甲方与外部接口状态清单
记录 DMS 及电子班牌等外部接口的实时连通、鉴权、真实联调凭据与 Mock 状态,严禁 Mock 冒充真实。
集成工程师、外部联调人员
05A 05A-CLIENT-PROVIDED-API-CATALOG.md 甲方提供外部接口总账 (27 个唯一接口)
记录甲方正式向项目交付的原始 DMS API 契约、参数结构、响应要素与脱敏凭据,严格区分契约来源与运营提供商。
甲方对接、集成工程师、契约审计
06 06-DEMO-BASELINE.md 演示基线准则与重构要求
明确旧 Demo 不可信与新 Demo 尚未开始的事实,确立纯净数据库与确定性数据等 7 大原则。
QA、测试架构师、验收人员
07 07-KNOWN-GAPS.md 内部已知缺口与外部阻塞清单
仅记录经过严格验证的真实缺口(ACCOM-PERM-01 已解决闭环,记录 DMS 外部硬件阻塞与 C03 成绩收敛等)。
研发团队、排期人员、问题排查
08 08-NEXT-ACTIONS.md 下一阶段标准化 16 步行动路线图
固定从环境冻结、纯净库重建、种子数据灌入到最终 Docs Phase B 的 16 步标准流。
项目经理、技术负责人

4. 历史版本审计与归档记录

在本次 Bootstrap 启动前,原 docs/current/ 目录下共存有 8 份历史文件。经逐篇与底层代码及 Git HEAD 审计,判定结论如下:

  • README.md:STALE,原速览索引缺少真理优先级声明与新架构映射,已被本文件彻底重构替代。
  • 01-current-status.md:STALE,基于 2026-09-17 早期快照,已被 01-CURRENT-SYSTEM-STATE.md 取代。
  • 02-phase1-status.md:STALE,粗粒度判定,已被 02-FUNCTION-MODULES.md 精确五级判定取代。
  • 03-shared-trial.md:STALE,描述 2026-09-17 部署快照,安全移入归档。
  • 04-known-gaps.md:STALE / NEEDS_REWRITE,已被 07-KNOWN-GAPS.md 取代。
  • 05-next-actions.md:STALE,编写于 2026-09-18,待办已过期,已被 08-NEXT-ACTIONS.md 的 16 步路线图取代。
  • 06-shared-trial-accounts.md:STALE,早期演示账号清单,安全移入归档。
  • 07-analytics-attendance-semantics.md:CURRENT (SPECIALIZED),Package C 考勤专题统计语义,属专项技术规范,为保持顶层 9 篇架构精简,归入归档留存备查。

所有上述 8 份原文档均已完整保留在: docs/archive/shared-trial-baseline-20260920/ (无任何物理删除,历史凭证完全可追溯)。