跳转至

参与维护

维护知识库的目标是把已经确认、能够复核的信息整理清楚,而不是为了填满页面补写未经确认的内容。修改前先判断信息是否适合进入仓库,并找到对应页面,避免同一事实分散在多处。

维护前注意

  1. 先确认事实:安全要求、仪器操作、数据处理参数、采购报销和联系人职责,应由实际负责人或有经验的成员确认。
  2. 保留不确定状态:尚未确认的内容标为“待确认”或“草案”,不要把推测写成正式流程。
  3. 不要提交敏感信息:密码、验证码、API Key、私钥、未公开研究数据和不适合公开的个人信息不得进入 Markdown、图片或 Git 历史。
  4. 一项事实只维护一处:仪器位置、成员信息、门禁方式等内容应链接到已有页面,不要复制出多个版本。
  5. 高风险操作优先线下确认:Wiki 不能替代安全培训、仪器授权、现场指导和紧急联络。

经成员同意用于组内协作的成员联系方式,以及现行门禁备用方式,按实验室已经确认的内部信息边界保留。该例外不扩展到密码、验证码、API Key、访问令牌、私钥或未公开研究数据。

维护优先级

  1. 安全、紧急处理和新成员必须掌握的信息。
  2. 高频使用仪器的 SOP、预约方式和负责人。
  3. Abs、TA、PL、WITec Raman/AFM 数据处理流程。
  4. 简明的服务器和计算资源使用说明。
  5. 常见故障、采购、报销和其他经验性问题。

选择维护入口

  • 贡献指南:分支、提交、审核、Pull Request 和发布流程。
  • 图片格式:截图、仪器图、WebP 压缩、文件命名和隐私处理要求。

复核与发布规则

  • 安全、入组、仪器 SOP 和仪器故障页面至少每 6 个月复核一次。
  • 采购、危废、计算、代码镜像、AI 服务和其他制度页面至少每 12 个月复核一次。
  • 设备、人员、联系人、地址、软件或制度发生重大变化时,不等待固定周期,立即更新。
  • 信息提供人可以提交现场事实;页面只有在邓宏健完成最终确认后,才能移除“草稿/待确认”状态。
  • SOP 页首维护文档编号、版本、确认人与日期,页末保留简短变更记录;Git 继续保存完整修改历史。

提交前检查

  • 内容放在正确栏目,标题和链接能够说明用途。
  • 新增步骤具有来源或实际操作依据。
  • 草案与正式要求有明确区分。
  • 图片已经遮挡密码、验证码、手机号、邮箱和未公开数据。
  • 本地执行 mkdocs build --strict 并确认构建通过。
  • 修改范围只包含本次需要发布的文件。

需要完整协作流程时继续阅读贡献指南