[Documentation] [TitleIndex] [WordIndex

rosgraph/Reviews/2009-12-30_Doc_Review

Reviewer:

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?

Jeremy Leibs

  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?
    • Could maybe use comment about the fact that these are tools only and there is no programmatic API, etc. I'm fine without this, but I've seen it in other packages.
  2. Are all of these APIs documented?
    • Command-line invocation of both tools is 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?
    • Covered in ROS/Tutorials/UnderstandingTopics tutorial. Nothing fancy enough to warrant its own tutorial.
  4. Is it clear to an outside user what the roadmap is for the Package?
    • Mentions rxgraph2 as future replacement
  5. Is it clear to an outside user what the stability is for the Package?
    • Roadmap mentions that rxgraph will be phased out, but this is down at the bottom of the page. Maybe move to top of page?
  6. Are concepts introduced by the Package well illustrated?
    • Nodes and Topics link to correct topics

Concerns / issues

Conclusion

Doc reviewed


2020-02-22 13:10