rosunit/Reviews/2011-01 Diamondback Doc Review_Doc_Review


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



Doc reviewed

Wiki: rosunit/Reviews/2011-01 Diamondback Doc Review_Doc_Review (last edited 2011-01-12 18:20:45 by KenConley)