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


  • RobotState is called out in the introduction but it's not on the mainpage of doxygen. --> DONE

  • What is Robot class? --> DONE (removed from the main page documentation and usage documentation. Normal users should not interact with it. For advanced users, there is doxygen api documentation)

  • Chain, Transmission have no doxygen. --> DONE

  • RobotState, JointState has minimal doxygen --> DONE

  • There are no tutorials or pointers to example code. --> DONE

  • There is no roadmap or stability statement (preferably in manifest) --> DONE

  • There is a good summary for most components, but as someone not familiar with any of the components I have no clue how to actually put them together to make a system work. --> DONE (tutorials cover this)


Wiki: pr2_mechanism_model/Reviews/2009-11-09_Doc_Review (last edited 2009-11-13 18:42:46 by wim)