The documentation team relies on the knowledge of subject matter experts (SMEs) to produce accurate and complete documentation that is suitable for use by its intended audience. We ask SMEs across edX teams, and sometimes externally, to review documentation before it's released publicly.

Reviewers are asked to comment on the accuracy and completeness of the documentation draft. Here are a few guidelines that might be useful to keep in mind.

The doc team follows this tech review process.

  1. The member of the doc team submits new or changed document for review in one of the following ways.
  2. The SME replies by adding comments to the pull request or as preferred (email, hardcopy, etc.).
  3. The doc team incorporates the changes. If the doc team has further questions, the doc team submits the doc for tech review again.
  4. The doc team publishes the documentation.