• 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: Updated for consistency issues and minor clarificatio. As this is an unstable API, not expecting tutorials or lots of usage docs as this is mainly to support use with the simulator. Works for me.


Wiki: polled_camera/Reviews/2010-01-11_Doc_Review (last edited 2010-01-12 00:51:48 by KenConley)