# [[Docs Like Code]]
## Metadata
- `Tags:`
- `Type:` ;
- `Author:` [[@Anne Gentle]]
- `Full Title:` Docs Like Code
- `Category:` books
- `General Subject:`
- `Specific Subject:`
- `ISBN:`
- `DOI:`
- `Publish Date:`
- `Reviewed Date:` [[2021-11-06]]
## Highlights
- If you have a simple product, a single repo that contains both the code and docs can be easiest. [(Location 334)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=334)
- To evaluate an API’s complexity, multiply how many methods it has by how many parameters, headers, and error codes each method has. Then, match the number of assigned development and docs resources to the API’s complexity. [(Location 432)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=432)
- Realize that the further the docs are from the code, the more difficult it can be to keep in sync. [(Location 625)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=625)
- Think about creating a culture where code changes don’t merge without corresponding doc changes. [(Location 626)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=626)
- End the tedium, enable the robots. [(Location 822)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=822)
- Read the GitHub documentation for reviewing changes in pull requests. [(Location 1021)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=1021)
- Some guidelines: Let newer reviewers do the reviews on the first day that a patch is up. This approach gives new reviewers more time to learn the doc set and complete their reviews. Encourage more experienced reviewers to step in after the initial review. This approach lets newer reviewers learn from other reviewers’ comments in subsequent reviews. Pair experienced reviewers with newer reviewers. To tag additional reviewers, use the @ symbol with a GitHub user name in a review comment. For example, @annegentle. For small technical suggestions, patch the patch yourself. Never merge a patch, however, until the original author has a chance to review your changes. If your review might sound a bit harsh to a new reviewer, reach out on chat, IRC, or in a private email. Let contributors know that your aim is to instruct and that you appreciate their work. [(Location 1168)](https://readwise.io/to_kindle?action=open&asin=B08KY82ZSB&location=1168)