common/Reviews/2009-10-05_Doc_Review

Reviewer: Tully Foote

Instructions for doing a doc review

See DocReviewProcess for more instructions

1. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
2. Are all of these APIs documented?
3. Do relevant usages have associated tutorials?

4. Have all Packages in the Stack been API reviewed?

5. Does the Stack conform to the StackDocumentation guidelines?

6. Are there Packages in the Stack that don't belong

Concerns / issues

Vijay

• Are there Packages in your Stack that don't belong?

  • Move actionlib_tutorials into ros_pkg_tutorials

• Looking at common/Roadmap, not sure what is meant by “This stack is focused on stability”

  • Suggestion: Given that this is a very low level stack, development should be focused on stability. This stack will try to maintain backwards compatibility for as long as possible.

• The version policy and development model explanations maybe should be moved to the main page. Roadmap doesn't really make sense

Conclusion

Issues resolved -> Done