• kwc
  • Tully

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


  • pr2_description manifest needs a description stating the purpose and users of the package.

    • (./) Fixed on trunk.

  • pr2_msgs should give a summary of what different messages are used for. PowerBoardState vs PowerState is not obvious from the name.

    • (./) Added descriptive comments to all .msg files, on trunk.

  • What is the timeline for deprecation/removal of deprecated messages? Why are they not removed for the release?
    • (./) They will be removed as soon as possible. There is too much delay in the development cycle on the power and battery system to ensure that it's safe to remove them now.


did all my updates inline


Wiki: pr2_common/Reviews/2010-01-18_Doc_Review (last edited 2010-01-19 04:05:49 by KenConley)