executive_smach/Reviews/2011-01 Diamondback_Doc_Review

Reviewer:

• Ken
• Wim

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

Stack maintainer should be switched to 'wim'

Two containers have not been documented (Melonee will handle, tickets assigned)

Roadmap is out-of-date, e.g.

• explore programmatic use of APIs
• event-based API (or possibly URBI instead)

Conclusion