官方说明书 - scutrobotlab/RM2022_SimulatorX GitHub Wiki

官方说明书

设计起因

Simulator 阶段,我们制作了一份 PDF 版本的操作手册。但是由于其静态性的特点,并不易于更新。

前期实现 Gitbook

前期我们使用 Gitbook 作为说明书,每次使用 Markdown 语法编写好后在 Git 中推送,CI-CD 会自动将其部署到说明书的展示服务器上。这个策略我们从 2022 年 3 月一直用到了 2022 年 7 月。

后期实现 飞书 Wiki

随着说明书内容的增加,我们发现使用上述的方法并不利于多人协作。正好实验室在使用飞书进行文档协作,因此我们决定使用飞书的知识库功能作为说明书。 实现效果 https://scutrobotlab.feishu.cn/wiki/space/7100397454918451228

为了方便用户记忆网址,我们将 intro 的子域重定向到上述链接

最后形成的网址是 https://intro.sim.scutbot.cn/

页面框架

  • 首页
  • 操作指南
  • 联机方式
  • 机器人控制
  • 界面指引
  • 语音聊天
  • 版本迭代
  • 版本号说明
  • 常见问题

版本迭代

这部分页面记录了模拟器从 0.5.0 到目前的所有发布版本的更新内容,每个版本都有一个独立的页面。通过阅读这部分内容,用户可以深入了解模拟器发展的全过程。

实现效果