common/Reviews/2011-07 Electric Review_Doc_Review

Reviewer:

• ken

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

kwc:

• tinyxml: see separate document

• yaml_cpp needs migration guide

  • Fixed: I ran through this myself. I had some typos (yamlcpp instead of yaml-cpp). I have now ported a package using the guide.

Conclusion