Sometimes the documentation team needs an engineer, PM, or both to review documentation before it's released publicly. Below is our suggestion for a tech review process.
- The member of the doc team submits a document for tech review in one of the following ways.
- Submits a pull request for the changes, and tags the engineer in the pull request.
- Builds a draft of the content on readthedocs, and sends the URL of the pages to be tech reviewed to the engineer.
- Creates a PDF of the document, adds comments to the PDF, and sends the PDF to the engineer or PM.
- Mark: We could add the PDF to our Dropbox folder, but that would mean granting a lot of users access to that folder. Is there a better way to do this?
- Question: Is there a list of engineering contacts we can use?
- The engineer or PM replies by adding comments to the pull request or PDF, or by sending comments about the HTML.
- Question: What's a reasonable turnaround time?
- The doc team incorporates the changes. If the doc team has further questions, the doc team submits the doc for tech review again.
- The doc team publishes the documentation.