TECHNICAL WORKSPACE · PROTOTYPE DIRECTORY

UmayShop 技术文档平台 · 界面原型目录

查看 README.md 查看页面清单 打开主原型 (docs.html)

集中呈现 UmayShop 跨境电商平台(中哈业务)技术文档体系、GitLab 自动化流水线任务、仓库覆盖率与缺口治理原型。集成 14 大类标准技术规范模板双语示例、离线矢量架构图,以及 website0813 仓库真实只读采集验证快照与 23 条同期需求参考资料。

【严谨声明与事实边界】
① 虚构规范示例:14 类技术文档模板全文字段为排版与流程演练的虚构示例,用于验证阅读器、页内目录、双语切换与本地导出链路,不代表真实生产技术文档已编写验收完毕。
② 固定只读验证快照:Web 真实验证区数据为针对 umay/website0813 master 分支固定比较(staging-2.0.289 → staging-2.0.290)的单次只读核验快照,不含敏感令牌或私有环境凭据,未接入常驻外网服务。
③ 排除范围锁定:umay/cis-mep 及其所有下级子树已全树排除,不计入采集与验收分母。
④ 未决事项台账:系统主体 Backend/WMS 来源及各模块责任人遵从 page-inventory.md D-01 至 D-10 未决条款。
6 核心原型页面 P-01 至 P-06 管理控制台
14 标准文档规范大类 28 篇中英双语全文示例
7 离线高清晰矢量图 SVG 系统架构与业务流转
1 真实项目只读快照 website0813 staging 差异
23 同期需求参考资料 doc-and-issues 关联摘录

核心业务页面导航 (P-01 ~ P-06)

严格保持 6 页边界,Ant Design Web 语义,不增加额外业务页面
P-01 文档 mixed
一级菜单
文档工作区
admin/docs.html

平台核心阅读与导览工作区。集成 14 大类技术文档模板全文字段示例、中英双语即时切换、7 张离线矢量架构图、全套 ZIP/Markdown 下载;内置 Web 真实验证快照与同期需求资料区。

P-02 文档 list
上下文回流
搜索结果
admin/search.html

全局关键词检索与多维筛选中心。覆盖 14 篇中文 + 14 篇英文模板全文及多语言片段(共 34 条预置演示数据),支持按模块分类和语言过滤,展示空查询与无结果状态。

P-03 文档 detail
上下文回流
更新审阅
admin/review.html

文档版本修订对比与发布审阅。提供代码变更源码差异(Diff)双栏比对、中英俄三语对照、证据缺口强制阻断发布机制,以及人工补充与退回审批交互。

P-04 运行管理 list
一级菜单
同步任务
admin/sync-runs.html

GitLab 代码仓库自动化同步流水线状态看板。展示成功、失败、部分完成等任务状态,支持排队重试、失败原因独立抽屉排查,并展示真实单项目只读快照摘要。

P-05 运行管理 list
一级菜单
文档覆盖与缺口
admin/coverage.html

5 个候选代码库的文档覆盖率与缺失项台账。提供按缺口筛选、负责人台账、后端与 WMS 来源缺失提示(明确全树排除 CIS 扩展平台)。

P-06 管理 mixed
一级菜单
接入与模板配置
admin/settings.html

代码源与模板规范管理。支持自建 GitLab 接入源配置、App 分支锁定(dev)、全局排除路径(umay/cis-mep/**)、Markdown 规范模版编辑校验及模拟连接测试。

14 大类技术文档标准规范目录全景

每个大类均提供完整中文与英文模板示例正文,直达对应章节
编号 文档分类名称 英文对应标题 标准规范内容与结构 架构/流转图 正文直接入口
01 项目概述与系统架构 Project Overview and System Architecture 14 个标准规范章节 系统交互架构图 中文正文 English
02 基础设施、域名、IP及访问权限 Infrastructure, Domains, IPs, and Access Permissions 14 个标准规范章节 网络拓扑架构图 中文正文 English
03 Backend / 后端服务 Backend / Backend Services 15 个标准规范章节 微服务组件图 中文正文 English
04 Web / 网页端应用 Web / Web Application 13 个标准规范章节 文本规范 中文正文 English
05 Mobile / 移动端应用 Mobile / Mobile Application 13 个标准规范章节 移动端流转图 中文正文 English
06 Admin / 管理后台 Admin / Management Console 13 个标准规范章节 文本规范 中文正文 English
07 WMS / 仓库管理系统 WMS / Warehouse Management System 13 个标准规范章节 文本规范 中文正文 English
08 Delivery / 配送与物流 Delivery / Delivery and Logistics 15 个标准规范章节 运力调度流程图 中文正文 English
09 API / 接口与系统集成 APIs / Interfaces and System Integration 15 个标准规范章节 接口时序示意图 中文正文 English
10 数据库与数据模型 Database and Data Models 15 个标准规范章节 实体关系模型图 中文正文 English
11 安全与访问权限管理 Security and Access Permission Management 13 个标准规范章节 文本规范 中文正文 English
12 监控、日志与错误处理 Monitoring, Logging, and Error Handling 14 个标准规范章节 文本规范 中文正文 English
13 部署与版本发布说明 Deployment and Release Notes 14 个标准规范章节 文本规范 中文正文 English
14 技术债务、风险及改进计划 Technical Debt, Risks, and Improvement Plans 13 个标准规范章节 反向流程改进图 中文正文 English

真实项目验证快照与参考文档

基于授权只读接口获取的固定事实与需求文档参考

website0813 真实只读采集验证

已完成只读核验

针对 umay/website0813 网页端仓库进行了一次固定版本基准比较,未连接常驻在线轮询:

  • 代码仓库:umay/website0813 (默认分支:master)
  • 比对基准:staging-2.0.289 → staging-2.0.290
  • 采集内容:文件树比对、提交历史核验、提交事实摘要
  • 安全边界:仅只读 GET 提取,不存储私有令牌、密码或敏感 IP

同期需求资料与交付说明

需求参考台账

纳入 umay/doc-and-issues 同期资料,作为业务背景参考(不冒充已上线代码事实):

  • 纳入数据:23 条 Issue 摘录、52 条非系统讨论、2 篇已取得正文参考
  • 正文参考:Tezber API 接口规范、Admin 履约操作手册
  • 交付边界:3 项原附件访问缺口分别标注,关联仅为候选
  • 验收约束:主 PRD v0.5 / v0.6 对应,未决事项遵从 D-01~D-10

本地运行与开发维护指令

静态原型离线运行与测试门禁脚本说明
# 1. 启动本地离线 HTTP 服务 (默认端口 4173,浏览器访问 http://127.0.0.1:4173/ 即为本目录页) python3 -m http.server 4173 --bind 127.0.0.1 # 2. 重新编译生成 6 业务管理页面与 index.html 目录页 python3 _gen_pages.py # 3. 执行测试用例套件 (验证中英双语 28 篇正文、图片与导航) python3 -m unittest discover -s tests -p 'test_*.py' -v # 4. 执行全站静态门禁校验 (包含页面数量、链接有效性、唯一锚点与范围约束) python3 tests/validate_static.py

原型设计规范与约束备忘

遵循 Ant Design 视觉语言与严格的事实边界约束

Ant Design 核心设计原则贯彻:

  • 亲密性 (Proximity):严格采用 8px(小)、16px(中)、24px(大)、32px 间距阶梯,相关元素紧密聚合。
  • 对齐 (Alignment):标题与正文左对齐、表单标签与数值冒号对齐、代码统一等宽字体,避免单页混乱居中。
  • 对比 (Contrast):主行动点采用品牌蓝 #1766cf,危险与警告操作区分明确,主副标题层级分明。
  • 重复 (Repetition):整站复用统一的设计变量(--primary、--border、--radius)、统一图标集与组件风格。
  • 直截了当 (Direct Manipulation):正文与表格就地阅读、就地展开,减少繁琐跳转。
  • 足不出户 (Stay on Page):使用抽屉(Drawer)与模态框(Modal)承载来源证据、修改历史、失败排查与下载操作,保持主阅读连续性。

未决事项备忘 (D-01 ~ D-10):在用仓库主体来源(Backend/WMS)、正式发布规则、环境映射、内容分级与校对责任人仍需后续确认,当前静态原型不作为生产系统实现认定。