如何阅读 Wiki¶
本页帮助第一次使用知识库的成员快速理解页面结构、搜索方式和不同内容标记的含义。
找到所需内容¶
使用左侧导航¶
桌面端顶部标签用于切换知识分组,左侧栏显示当前分组中的栏目:
- 先从顶部选择“开始使用”“实验与规范”或“资源与支持”等分组。
- 再从左侧选择具体栏目,例如“仪器使用”或“计算资源”。
- 进入栏目下的具体文档后,可使用正文顶部的“返回上一级”入口。
- 点击顶部站点名称或左侧“首页”可返回总入口。
- 在窄屏或手机上,点击左上角菜单按钮打开导航。
使用右侧目录¶
右侧“目录”只显示当前页面的章节。点击标题可以快速跳到相应位置;滚动页面时,目录会跟随当前阅读位置。
左侧导航与右侧目录的区别是:
| 位置 | 范围 | 来源 |
|---|---|---|
| 左侧导航 | 当前知识分组中的页面 | mkdocs.yml 中的 nav |
| 右侧目录 | 当前页面的章节 | Markdown 中的二级、三级标题 |
使用全文搜索¶
点击顶部搜索框,输入仪器名、方法名、错误信息或关键词。搜索会覆盖已经发布的所有页面,并突出显示匹配内容。
建议先使用较短且明确的关键词,例如仪器型号、试剂名称或报错中的关键短语;结果过多时再增加限定词。
理解内容标记¶
页面中的彩色提示框用于表达不同优先级:
说明
提供背景、范围或补充信息。
建议
提供更方便或更可靠的做法,但通常不是强制要求。
警告
表示需要特别留意的风险、限制或前置条件。
危险
表示可能涉及人身、设备、样品或数据安全;必须先确认要求,必要时联系负责人。
页面待完善
表示页面仍是结构或草稿,不能直接视为已经生效的正式规定。
识别字段状态¶
页面会同时使用文字、颜色和边框标出内容缺口;即使在灰度显示或无法区分颜色时,也能依靠状态文字判断:
关键信息尚未提供,需要维护者补录。
候选内容尚未经过负责人审核。
对应的页面、SOP 或文档还不存在。
系统、仓库或联系入口尚未提供。
红色的 紧急信息待填写 只用于安全、故障或应急联系等高风险缺口。它不表示可以跳过,而是提示必须先通过其他已确认渠道获取信息。
阅读 SOP 和数据处理草案¶
阅读操作类文档时,建议依次确认:
- 文档是否适用于当前仪器、样品和实验目的。
- 是否需要培训、授权、预约或个人防护。
- 维护人、版本和最近复核日期是否有效。
- 关键参数是否包含单位,步骤是否存在前置条件。
- 异常、停机和紧急情况应该联系谁。
Wiki 不能代替培训
Wiki 用于保存和查找经过确认的知识,但不能代替安全培训、仪器授权或负责人的现场指导。
代码、命令与链接¶
- 行内灰色文字通常表示命令、文件名、路径或参数,例如
mkdocs build --strict。 - 代码块右上角提供复制按钮;粘贴执行前仍应检查路径、参数和当前环境。
- 蓝色文字通常是可点击链接,可能跳转到站内页面或外部资源。
- 表格适合快速查找,具体限制和步骤仍应阅读对应页面正文。
明暗模式与移动端¶
顶部的太阳或月亮图标可以切换明暗模式。站点会优先跟随系统设置,并记住浏览器中的选择。手机访问时,左侧导航和右侧目录会收进菜单中,正文内容不变。
内容不完整、过期或有误时¶
- 不要根据明显存疑的内容继续高风险操作。
- 先通过联系方式查找页面维护人、仪器负责人或实验室管理员;若具体职责或联系入口仍标为待填写,请使用实验室既有的线下渠道确认。
- 记录页面地址、问题位置、发现时间和建议修改内容。
- 按贡献指南创建工作分支和 Pull Request,交由管理员审核。
页面中标注“待填写”“待确认”“待创建”或“待添加链接”的内容表示尚未定稿;没有标记也不意味着永久有效,操作前仍应关注复核日期和现场要求。