Robot Model

Reviewer: Tully Foote

Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Is the description in the stack.xml informative? This shows up in the summary of the Stack wiki page.
    • It needs a longer description. The current description would work well for the brief, but all the aspects should be enumerated and point toward the constituent packages. And the purpose/usefulness of each package should be highlighted.
  2. For the expected usages of your Stack, are the necessary APIs documented? (in other words, internal APIs do not need to be documented, some justification needs to be provided by the component owner as to what is/isn't internal)
  3. Do relevant usages have associated tutorials?
    • an example line or two would be really nice in ivcon
  4. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
  5. Are all of these APIs documented?
  6. Do relevant usages have associated tutorials?
  7. Have all Packages in the Stack been API reviewed?

    • Yes
  8. Does the Stack conform to the StackDocumentation guidelines?

  9. Are there Packages in the Stack that don't belong
    • No

Concerns / issues

  • robot_model Add more to manifest description. (see above)

  • ivcon one quick tutorial with standard usage, then link to external documentation

  • resource_retriever needs documentation

  • Add summaries of each package and common usage on stack homepage.


Wiki: robot_model/Reviews/2009-10-02_Doc_Review (last edited 2009-10-08 00:28:24 by TullyFoote)