Growing issue with ROS Documentation

We are aware, and we actually used to have a full-time technical writer on staff. Unfortunately we could only afford one at that time (and as of today we can’t afford any) and a single full-time technical writer is nowhere near enough to handle the backlog of documenting ROS, Gazebo, Open-RMF and the infrastructure that supports them without community contributions doing the bulk of the work.

ROS 2 has project governance. @clalancette is the project lead, with 100% of his work time generously donated by Intrinsic. He leads a group of core contributors, and is doing a stellar job, in my opinion. You can see many of the various tasks they’re working on at the project boards.

But there’s only so much that a project leader and a group of core contributors and project management can do. Ultimately, ROS 2 is an open source project, and community contributions should make up the bulk of development. That includes documentation. Besides, no matter how much someone tries to direct volunteer developers (which is all that all contributors are, ultimately, including the core contributors), they’re going to focus on what they want to focus because the project leader is not their manager and has no contractual power over them.

If you see something missing from the documentation, add it and send in a pull request. If you find an error in the documentation, fix it and send in a pull request. If you can think of a way to improve the documentation infrastructure, do it and send in a pull request. This doesn’t require a project leader to tell you to do it, nor does it require someone to invite you to do it.

5 Likes