如何编写 MoveIt 操作指南

本指南介绍如何为 MoveIt 文档编写操作指南。本指南主要供 PickNik Robotics 的员工使用 以帮助标准化操作指南文档，但任何想要提交新指南的贡献者都可以使用。如果您正在寻找 使用 MoveIt 的操作指南，您可以在这里找到它们：操作指南。

学习目标

  • 操作指南中应包含的信息类型。

  • MoveIt 文档部分中操作指南的正确格式。

要求

  • Ubuntu 20.04

  • ROS 2 Galactic

  • MoveIt 2

步骤

  1. 分叉 MoveIt 2 教程存储库 并使用直观的名称（例如 jack/how-to-write-how-tos）开始一个新分支。

  2. 在 doc/how_to_guides 目录中创建一个带有 .rst 扩展名的新文件。标题应以“如何”开头，后跟要回答的具体问题（例如，“如何编写 MoveIt 操作指南”）。

  3. 在相应的操作指南页面上添加指向您的指南的链接：

#.使用 reStructuredText (.rst) 编写简介，遵循以下准则：

  • 标题应与文件同名。

  • 简介应解释本指南的目的和目标受众。

  • 如果您认为人们可能会经常错误地找到本指南，请添加指向适当资源的链接。

  1. 写下具体的学习目标（即读者读完本指南后将了解的内容）。

  2. 添加本指南的任何系统或设备要求，以便用户知道本指南是否适合他们。

  3. 列出各个操作步骤，不要遗漏必要的中间步骤。

  4. 创建一个链接到扩展信息的“进一步阅读”部分。

  5. 将新页面作为 PR 提交到 MoveIt 2 教程存储库。

模板

<标题>

<使用图片或 GIF 展示结果的“操作指南”的简要说明。>

学习目标

<用户将学习的内容列表。>

要求

<解释用户应该理解的内容。与教程不同，这些指南是独立的，可以假设用户具有更多的背景知识。>

步骤

<解决问题要采取的步骤列表。>

进一步阅读

<本网站内外相关内容的链接列表。>

进一步阅读