rxtools/Reviews/2010-01-10_Doc_Review
Reviewer:
- Nate
Instructions for doing a doc review
See DocReviewProcess for more instructions
- Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
- Yes
- Are all of these APIs documented?
- Yes
- 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?
- Yes
- If there are hardware dependencies of the Package, are these documented?
- N/A
- Is it clear to an outside user what the roadmap is for the Package?
- No
- Is it clear to an outside user what the stability is for the Package?
- No
- Are concepts introduced by the Package well illustrated?
- Yes
Concerns / issues
I'm not sure of the proper way to document a packages roadmap and stability. Those two items are the only two things missing.
- kwc: added to bottom of page
Conclusion
Good documentation, illustrations, and tutorials.
kwc: marking as doc reviewed
