Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. Do relevant usages have associated tutorials? (you can ignore this if a Stack-level tutorial covers the relevant usage), and are the indexed in the right places?
  4. If there are hardware dependencies of the Package, are these documented?
  5. Is it clear to an outside user what the roadmap is for the Package?
  6. Is it clear to an outside user what the stability is for the Package?
  7. Are concepts introduced by the Package well illustrated?
  8. Is the research related to the Package referenced properly? i.e. can users easily get to relevant papers?
  9. Are any mathematical formulas in the Package not covered by papers properly documented?

For each launch file in a Package

  1. Is it clear how to run that launch file?
  2. Does the launch file start up with no errors when run correctly?
  3. Do the Nodes in that launch file correctly use ROS_ERROR/ROS_WARN/ROS_INFO logging levels?

Concerns / issues


  • OccupanyGrid?:

    • o The occupancy value range is said twice in the .msg file.
    • Tully: Removed first instance to keep summary cleaner
  • Odometry:
    • o Is the comment, "The twist in this message should be specified in the coordinate frame given by the child_frame_id" correct? E.g., is our base controller filling this field with base_link
    • Tully: yes this is true now
  • GetPlan?:

    • o No documentation
  • GetMap?:

    • o No documentation

Tully: Documentation added to GetPlan and GetMap r24747



Wiki: nav_msgs/Reviews/2009-09-30_Doc_Review (last edited 2009-09-30 23:52:19 by TullyFoote)