终端服务部 · 技术知识库¶
上海中侨大学 · 人工智能学院 · 具身智能研究所 —— 终端服务部
这是实验室终端服务部的技术知识库。内容按本库的《知识库规范》组织。
先看这一页¶
| 你是 | 从这里开始 |
|---|---|
| 刚加入实验室,什么都不会 | 终端服务部介绍 → 里面的「新人上手路径」 |
| 想找人办事(要服务器、要网络、要账号) | 职责与服务目录 —— 先看 🟢🟡🔴 三档判据 |
| 要按顺序学一件事 | 学习 —— 一条路线,一章一章往下走 |
| 要部署或排查某类服务 | 参考 —— 一门技术一篇,用到时来查 |
| 踩了坑,想看看别人踩过没有 | 经验 —— 一个坑一篇 |
| 想照着做一个项目 | 项目 —— 每篇含完整复现步骤 |
| 要往这个库里写东西 | 知识库规范,然后读仓库根目录的 CONTRIBUTING.md |
| 想知道主书怎么收录这个库 | 读仓库根目录的 并入主书说明.md |
这个库是怎么组织的¶
内容分四条线,加两类管理页。规律很简单:看文件在哪个目录,就知道它是哪一类。
学习/ → 按顺序学会一件事(路线图 + 一章一章)
参考/ → 一门技术一篇,用到时来查
项目/ → 我们做出来的东西,含完整复现步骤
经验/ → 一个坑一篇:现象、原因、怎么修
历史与交接/ → 人员、设备、系统的变动记录
部门根页面与各类 README、规范 → 管理页
每一页开头都有一段元信息(类型、维护人、更新日期、状态、难度、适用版本)。状态: 草稿 的内容不要当成结论;状态: 待修订 表示内容曾经可用,但现在已知过时。旧结构与旧规范已删除,git 历史里查得到。
每一类页面必须有哪些章节、front-matter 有哪些字段,见知识库规范;本文提到的索引表都由脚本从 front-matter 生成。
两条边界¶
1. 公开库只放能公开的内容¶
这个仓库是公开的。凡是涉及内网地址、服务器台账、真实主机名与域名、账号与凭据位置的内容,都放在配套的内部库里。公开页面上会以「内部细节见内部库」的形式留一个提示。
判断标准只有一句:这段内容落到外面人手里,会不会给实验室添麻烦。
2. 内容不押注平台¶
本库的正文将来可能被要求整章并入实验室主书(现在用 MkDocs + GitHub Pages),所以这个库的做法是:
- 内容全是纯 Markdown,没有任何平台专有语法。
- 页面之间只用相对路径互链。
- 部门章是完全自包含的:
docs/部门/终端服务部/里不出现任何指向章外的链接,于是它随时能整棵搬走,不会产生断链(见仓库根目录的并入主书说明.md)。
仓库根目录同时提供了 MkDocs(mkdocs.yml)、GitBook(SUMMARY.md + .gitbook.yaml)和 LLM 读取(docs/规范/知识库规范.md + _schema/pages.json)三种入口,换平台不需要动内容。
怎么本地预览¶
python -m venv .venv
.\.venv\Scripts\pip install -r requirements-docs.txt
.\.venv\Scripts\mkdocs serve
然后打开 http://127.0.0.1:8000。(这里写成代码块:链接检查工具会真的去连它,本地服务没起来就报断链。)
还不完整的地方¶
这份库目前是骨架 + 已填实的部分内容。哪些页还没写、哪些事实还需要确认,维护在仓库内的内部台账里,不在各页面散落「TODO」。