Attention: Answers.ros.org is deprecated as of August the 11th, 2023. Please visit robotics.stackexchange.com to ask a new question. This site will remain online in read-only mode during the transition and into the foreseeable future. Selected questions and answers have been migrated, and redirects have been put in place to direct users to the corresponding questions on Robotics Stack Exchange. Additional details are available here.

Revision history [back]

There is not yet any defined best practice on documenting ROS2 packages. The ROS2 style guide does give some information on what should be in the documentation, but it does not prescribe a format. Use what you are familiar with, what is easy to maintain, and what produces good, readable documentation.

ROS Answers is licensed under Creative Commons Attribution 3.0 Content on this site is licensed under a Creative Commons Attribution Share Alike 3.0 license.