ROS/Reviews/2010-01-12 Doc Review Diamondback_Doc_Review


  • kwc

Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. Do relevant usages have associated tutorials?
  4. Have all Packages in the Stack been API reviewed?

  5. Does the Stack conform to the StackDocumentation guidelines?

  6. Are there Packages in the Stack that don't belong

Concerns / issues


  • Should 'author' of ros stack be switched to standard maintainer language?
  • I've removed most uses of MenuNavi now that ROS stack is less monolithic.

  • Maybe not for this release, but the ROS/CommandLineTools page should be broken apart.

  • The ROS stack page could use an update. Now that things are more separated, it should be less monolithic as well.


Wiki: ROS/Reviews/2010-01-12 Doc Review Diamondback_Doc_Review (last edited 2011-01-12 09:22:17 by KenConley)