user-help-docs

用户使用说明文档

本仓库为实验室安全智慧化管控系统_v3用户使用说明文档原始文件。

由产品及测试部门负责维护，由mkdocs驱动。

0 说明

本文档中心用于统一发布和管理实验室安全智慧化管控系统相关的用户使用说明、操作指引及规范性文档，面向学校实验室管理部门、学院管理人员、实验室负责人、实验室使用人员及相关使用人员提供权威、规范、可持续更新的参考依据。

文档内容围绕系统的整体使用原则、操作流程、管理规范及常见问题展开，旨在帮助各级用户准确理解系统功能定位，规范使用方式，提升实验室安全管理的信息化、规范化和精细化水平。

本文档中心将根据系统建设进展和实际运行情况持续更新，作为系统使用和管理的重要支撑资料，供相关人员在日常工作中查阅和参考，文档中心将随系统功能优化与管理要求调整持续迭代更新，确保内容的时效性与准确性。

1 部署及使用

拉取本仓库到本地

cd your_tag_path    # 选中目标文件夹
mkdir your_folder_name   # 设置你本地存放位置
git clone remote_repo_url  # 拉取本仓库到本地  

文档构建和使用依赖于mkdocs，请先确认本地已部署mkdocs，若未部署请先完成mkdocs安装。

进入docs目录

cd user-help-docs

预览

mkdocs serve # 注意执行serve路径必须为配文件.yml所在目录

启动本地服务后访问即可预览，所见即所得，支持热更新。

http://127.0.0.1:8000

构建

在mkdocs.yml配置文件所在目录执行构建

mkdocs build  # 执行静态页面构建，构建时会在当前目录创建site文件夹，构建完毕后的文件会在site中，可用于分发和部署

2 更新及贡献

• 根据系统模块变更维护相应的.md文档。
• 如需新增模块，请在docs下新增对应的模块文件夹，再创建对应的.md文档，请务必保证结构为docs/moduleNameFolder/xxxxx.md，同时更新mkdocs.yml配置文件中的目录以保证路由正常。
• 文档中图片资源统一采用相对路径存放至docs/assets/images下，视频文件同理，若新增本地化的js脚本或者样式文件，存放在assets下对应javascripts 、stylesheets下即可。
• 如merge过程中出现了冲突，请及时和对应负责人确认后再合并，以免出现文件丢失。
• 请在每一次commit中明确对应的更改信息以便溯源。

3 其他

优雅的文档体系需各位共同维护。