rxdeps/Reviews/2010-01-12_Doc_Review

Reviewer:

  • kwc, tfield

Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. 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?
  4. Is it clear to an outside user what the roadmap is for the Package?
  5. Is it clear to an outside user what the stability is for the Package?
  6. Are concepts introduced by the Package well illustrated?

Concerns / issues

kwc: I added a note to make it clear that generates PDFs. Other than that, short and sweet.

tfield: might be nicer if the image were larger/intelligible, otherwise this looks fine. Bonus point for teaching me a new word: deduplicate.

Conclusion

Doc reviewed

Wiki: rxdeps/Reviews/2010-01-12_Doc_Review (last edited 2010-01-15 00:36:28 by TimField)