[Documentation] [TitleIndex] [WordIndex



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?
    • kwc: added note that plugin API is not to be used
  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?
    • kwc: no, but marking this for future
  4. Is it clear to an outside user what the roadmap is for the Package?
    • kwc: yes
  5. Is it clear to an outside user what the stability is for the Package?
    • kwc: yes
  6. Are concepts introduced by the Package well illustrated?
    • kwc: yes

Concerns / issues

kwc: rxbag will need tutorials, or rxbag_plugins for that matter. There are a lot of features, and it's hard at first to realize they are there.


Doc reviewed for ROS 1.0 as this is a relatively new component, and there is active development around this, we can wait until a more stable release of rxbag

2022-11-26 13:04