• 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. Is it clear to an outside user what the roadmap is for the Package?
  5. Is it clear to an outside user what the stability is for the Package?
  6. Are concepts introduced by the Package well illustrated?

Concerns / issues


kwc: documentation covers relevant APIs and there are tutorials. Obviously, this will slowly migrate over to rosbag over time. Also, as the code API is improved, it will be useful to have tutorials there as well.

Wiki: rosrecord/Reviews/2010-01-20_Doc_Review (last edited 2010-01-22 01:57:49 by KenConley)