操作指南

操作指南与教程截然不同，因为它们面向不同的受众。 操作指南是**面向问题**的，并假设读者来到此页面是为了回答特定问题。 这些页面具有以下特点：

  • 一系列步骤

  • 专注于目标

  • 解决特定问题

  • 没有不必要的解释

  • 一点灵活性

  • 实用性

  • 良好的命名

在教程中，您会仔细指导读者完成一系列步骤，目的是学习。 正在学习教程的读者还不太了解术语或概念，无法提出具体问题。 操作指南的读者已经在使用 MoveIt，但正在寻找有关执行特定操作的说明。

名称回答用户的问题

操作指南回答非常具体的问题，应该可以捕获 Google 搜索。 因此，命名非常重要。 好名字的例子有：

  • 如何在 MoveIt 中可视化碰撞

  • 如何使用 MoveIt 抓取物体

  • 如何使用 UR5 运行 MoveIt

  • 如何修复段错误

  • 如何从 Foxy 迁移到 Galactic

  • 如何在 Gazebo 中运行

  • 如何为 MoveIt 设置新机器人

  • 如何使用 MoveIt RViz 插件

  • 如何使用控制器伸缩机械臂

以目标为中心且实用

对于这些指南，重要的是您要专注于解决用户访问网站的问题。 因为这些用户已经对核心概念有了更深入的理解，所以当用户需要权衡利弊时，您应该向他们提供一些选项。 您应该在操作指南的介绍中说明假定的先决条件是什么。 通过这样做，您可以避免在本网站上重复说明，并允许已经了解先决条件的用户直接解决他们的问题。