Monday, September 30, 2019

The Ten Commandments of Code (or Doc) Reviews

I've seen several articles about how painful code reviews can be for developers, but not as many about documentation reviews. That may be because there aren't as many documentation reviews or they don't get held to the same standards. But they are similar many respects, and they can be painful for writers to endure (speaking from personal experience).

The 10 Commandments of Navigating Code Reviews could almost have been written for technical writers and documentation reviews.
The first two commandments are especially relevant:

  • Thou shall not take it personally.
  • Thou shall not marry thy code (or docs, in the case of writers).

Yes, there are some differences between the two kinds of reviews, but not as many as you might think. Most writers should find this article relevant, espeically if you work for a company that has a formal review process.

No comments: