[Documentation] [TitleIndex] [WordIndex


Proposer: Jack O'Quin



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. If there are hardware dependencies of the Package, are these documented?
  5. Is it clear to an outside user what the roadmap is for the Package?
  6. Is it clear to an outside user what the stability is for the Package?
  7. Are concepts introduced by the Package well illustrated?
  8. Is the research related to the Package referenced properly? i.e. can users easily get to relevant papers?
  9. Are any mathematical formulas in the Package not covered by papers properly documented?

Concerns and Issues

Enter your thoughts on the documentation and any questions or concerns you have here. Please sign your name. Anything you want to address in the review should be documented here before the start of the meeting.

Meeting agenda

As there is not much controversy, we decided to have the Conclusion discussion via e-mail. This page will be updated to reflect the results.

This meeting is scheduled for 2010-06-22 at 3:00PM Central Time (1:00PM Pacific Time).


Completed tasks:

Deferred until later:

This review is now closed.

2020-08-08 12:29