Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. The member of the doc team submits new or changed document for review in one of the following ways.
    • Submits a pull request for the changes, and uses the Doc Team Pull Request Template to identify and tag SMEs.
    • Builds an HTML draft of the content on readthedocs, and sends the URL to the reviewer.
  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.

Levels of Edit

The doc team uses these terms to describe different types of editorial work. 

...