From e6be6058a5c59310627790a4e9b9e81e26ea1914 Mon Sep 17 00:00:00 2001 From: Armor00 <2654988228@qq.com> Date: Thu, 28 May 2026 11:33:19 +0800 Subject: [PATCH] docs: add project handover guides --- handover/ksp_wiki_handover.md | 691 ++++++++++++++++++++++++++ handover/operation_hangar_handover.md | 559 +++++++++++++++++++++ 2 files changed, 1250 insertions(+) create mode 100644 handover/ksp_wiki_handover.md create mode 100644 handover/operation_hangar_handover.md diff --git a/handover/ksp_wiki_handover.md b/handover/ksp_wiki_handover.md new file mode 100644 index 0000000..a6c4018 --- /dev/null +++ b/handover/ksp_wiki_handover.md @@ -0,0 +1,691 @@ +# KSP Wiki.js 工作流交接文档 + +最后更新:2026-05-28 + +本文档介绍 KSP Wiki 内容生产与 Wiki.js 发布工作流。后台项目本身、数据库模型和 Mission Ops 功能见 `handover/operation_hangar_handover.md`。 + +## 1. 这套工作流是什么 + +KSP Wiki 工作流用于把 KSP Operation Hangar 中整理出的航天器设定、任务记录和运营数据,转化为 Wiki.js 上的百科条目。它不是单纯写 Markdown,而是一套从设定讨论、本地 HTML 编写、图片资产上传、页面发布、缓存刷新到前台验证的完整流程。 + +当前主要维护对象包括: + +- 航天飞机条目:秃鹫、回声、进取。 +- 星际探索母舰条目:羲和、万星源 / Stellaria。 +- 航天器图片资产。 +- Wiki.js 页面 CSS、页面 JS 和图片点击放大 lightbox。 + +核心原则: + +- 本地 HTML 是事实来源,先在仓库内修改,再发布到 Wiki.js。 +- 发布必须通过脚本走 Wiki.js GraphQL `pages.update`/`pages.create`,并执行 render/flushCache。 +- 发布后必须做前台验证,不只看数据库。 +- 涉及临时 `manage:system` 权限时必须先向用户确认,并确保脚本结束后移除。 +- 不打印 `.env`、密码、JWT 或数据库连接串。 + +## 2. 本地内容文件 + +主要 Wiki HTML 位于 `data/wiki/`: + +| 文件 | 语言 | 页面 | +| --- | --- | --- | +| `data/wiki/vulture_shuttle_zh.html` | zh | 秃鹫航天飞机 | +| `data/wiki/vulture_shuttle_en.html` | en | Vulture Shuttle | +| `data/wiki/echo_shuttle_zh.html` | zh | 回声级航天飞机 | +| `data/wiki/echo_shuttle_en.html` | en | Echo Shuttle | +| `data/wiki/enterprise_shuttle_zh.html` | zh | 进取级航天飞机 | +| `data/wiki/enterprise_shuttle_en.html` | en | Enterprise Shuttle | +| `data/wiki/xihe_mothership_zh.html` | zh | 羲和级星际探索母舰 | +| `data/wiki/xihe_mothership_en.html` | en | Xihe-class interplanetary exploration mothership | +| `data/wiki/wanxingyuan_mothership_zh.html` | zh | 万星源级星际探索母舰 | +| `data/wiki/stellaria_mothership_en.html` | en | Stellaria-class interplanetary exploration mothership | + +根目录还有早期/参考文件: + +- `vulture_shuttle.md`:秃鹫中文长稿参考。 +- `vulture_shuttle_html_test.html`:早期 HTML 测试稿。 + +图片和资源通常位于 `data/KSP/` 下的 wiki 上传目录,例如: + +- `data/KSP/wiki-upload/` +- `data/KSP/wiki-upload-echo-current/` +- `data/KSP/wiki-upload-enterprise-current/` +- `data/KSP/wiki-upload-png/` +- `data/KSP/wiki-embed-current/` + +## 3. 当前已经完成的内容 + +### 3.1 航天飞机页面 + +已完成并发布的主要页面: + +| 页面 | Locale | 已知 Page ID | 路径 | +| --- | --- | --- | --- | +| 秃鹫航天飞机 | zh | 18 | `home/Space_Shuttles/Vulture_Shuttle` | +| Vulture Shuttle | en | 21 | `home/Space_Shuttles/Vulture_Shuttle` | +| 回声级航天飞机 | zh | 8 | `home/Space_Shuttles/Echo_Shuttle` | +| Echo Shuttle | en | 22 | `home/Space_Shuttles/Echo_Shuttle` | +| 进取级航天飞机 | zh | 7 | `home/Space_Shuttles/Enterprise_Shuttle` | +| Enterprise Shuttle | en | 23 | `home/Space_Shuttles/Enterprise_Shuttle` | + +内容状态: + +- Vulture 中文页已扩展为大型百科条目,包含设计、系统组成、任务剖面、运用历史、飞行次数、安全事件、机队、成本和技术参数。 +- Vulture 英文页已修正旧稿措辞,去掉 `English draft`、`local Chinese article` 等草稿痕迹,并补齐 Xihe/Stellaria 互链。 +- Echo/Enterprise 中文页已扩写到 Vulture 级别的丰富度,包含背景、设计需求、系统组成、推进、电源、整备、任务剖面、母舰支援、运用历史、机队编号、安全事件、经济性和评价。 +- Echo/Enterprise 中文页当前有本地润色版,用户要求先本地保存,暂不发布云端。 + +### 3.2 母舰页面 + +已完成并发布的主要页面: + +| 页面 | Locale | 已知 Page ID | 路径 | +| --- | --- | --- | --- | +| 羲和级星际探索母舰 | zh | 13 | `home/Exploration_Motherships/Xihe/XH-01` 或相关 Xihe 路径 | +| Xihe-class interplanetary exploration mothership | en | 24 | `home/Exploration_Motherships/Xihe` | +| 万星源级星际探索母舰 | zh | 15 | `home/Exploration_Motherships/Stellaria` | +| Stellaria-class interplanetary exploration mothership | en | 25 | `home/Exploration_Motherships/Stellaria` | + +关键设定: + +- XH-02 是太白 / Taibai。 +- XH-03 是常曦 / Changxi,不是 Zhuque。 +- Stellaria 是万星源级英文名。 +- ST-01 与 ST-02 是万星源级早期高速度增量构型。 +- 当前中文统一 ST-02 为“万星源NEXT号(ST-02)”。 + +### 3.3 术语和设定统一 + +已清理过的错误或旧稿词: + +- `English draft` +- `local Chinese article` +- `XH-03 Zhuque` +- `Zhuque` / `朱雀` +- `克里斯滕号(ST-02)` + +当前推荐术语: + +| 中文 | 英文 | 说明 | +| --- | --- | --- | +| 秃鹫航天飞机 | Vulture Shuttle | 重载航天飞机主线 | +| 秃鹫航天飞机改进乙型 | Vulture Shuttle Block 2 | 高能推进重载干线 | +| 回声级航天飞机 | Echo Shuttle | 母舰随舰摆渡航天飞机 | +| 进取级航天飞机 | Enterprise Shuttle | 中型客货运输与母舰近程支援 | +| 羲和级星际探索母舰 | Xihe-class interplanetary exploration mothership | 第一代探索母舰 | +| 万星源级星际探索母舰 | Stellaria-class interplanetary exploration mothership | 后续大型探索母舰 | +| 摆渡航天飞机 | ferry shuttle | 母舰目标系统末端运输载具 | + +## 4. 从 brainstorming 到 HTML 的写作流程 + +Wiki 条目通常按以下顺序生产: + +1. 与用户确认设定定位。 +2. 建立条目骨架。 +3. 从 KSP Operation Hangar 后台读取任务日志和运营上下文。 +4. 写本地 HTML。 +5. 本地润色和术语一致性扫描。 +6. 用户确认。 +7. 发布到 Wiki.js。 +8. 前台验证。 + +### 4.1 Brainstorming 阶段 + +先确认页面的百科定位,而不是直接堆设定。例如 Echo 与 Enterprise 的分工: + +- Echo:随舰远征、双艇互备、大气天体探索、卫星间摆渡、小型样品和应急撤离。 +- Enterprise:中型节点、25 吨级货运、22 人短期运输、母舰建造/改装/补给、返港卸载。 +- Vulture Block 2:重载地月干线,不是 Echo/Enterprise 的简单替代。 + +写作时先确定: + +- 它属于哪一代技术路线。 +- 与前代或并行型号的关系。 +- 在航天运输体系中的层级。 +- 不承担哪些任务。 +- 与任务日志中的运营记录如何对应。 + +### 4.2 HTML 结构 + +本地 HTML 通常包含: + +```html + +
+

...

+ ...
+ + ...正文... +
+ +``` + +发布时使用 `--extract-style-to-script-css` 和 `--extract-script-to-script-js`,脚本会把第一个 `