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? Yes, these are only command line tools and the code API is not intended for use.

  2. Are all of these APIs documented? Yes.

  3. Do relevant usages have associated tutorials? No need for separate tutorials here.

  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?

For each launch file in a Package

No launch files


This package has a very simple API and the documentation is short but perfectly clear.

Wiki: image_view/Reviews/2009-12-17_Doc_Review (last edited 2009-12-17 20:01:35 by RomainThibaux)