• kwc

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?


Concerns / issues

kwc: Manifest description was a jumble, so I cleaned it up.

kwc: Removed references to building robot_monitor (we don't do that for other packages, and it is potentially wrong).

kwc: Fixed some minor consistency issues with "root monitor" vs. "Robot Monitor".


kwc: doc reviewed

Wiki: robot_monitor/Reviews/2010-01-08_Doc_Review (last edited 2010-01-09 02:00:47 by KenConley)