Googleがコードレビューのガイドラインなど、ソフトウェアエンジニアリング実践のためのドキュメント「Google Engineering Practices Documentation」を公開

Googleは、同社内のすべてのソフトウェア開発プロジェクトで実践しているプラクティスを開設する「Google Engineering Practices Documentation」を公開しました。

ライセンスはクリエイティブコモンズの「表示 3.0 非移植 (CC BY 3.0)」で、複製や再配布、営利目的を含めた改変や翻案が可能になっています。

Googleで一般化されたエンジニアリングプラクティス

Googleはこのドキュメントを次のように紹介しています。

Google has many generalized engineering practices that cover all languages and all projects. These documents represent our collective experience of various best practices that we have developed over time. It is possible that open source projects or other organizations would benefit from this knowledge, so we work to make it available publicly when possible.

Googleには、すべての言語とすべてのプロジェクトをカバーしている一般化されたエンジニアリングプラクティスが数多くあります。本ドキュメントは、私たちが長年にわたって開発してきたさまざまなベストプラクティスを集めたものです。オープンソースのプロジェクトや他社においても、これらの知見を活かすことができるはずなので、可能な範囲で公開するようにしました。

具体的な内容は、コードレビューのガイドライン「Code Review Developer Guide」となっています。

コードレビューで確認すべきこととして、以下のことが挙げられています。

• Design（システムにとって適切な設計か？）
• Functionality（作者が意図したとおりに振る舞うか？）
• Complexity（できるだけシンプルになっているか？）
• Tests（適切な自動テストが備わっているか？）
• Naming（変数やクラス、メソッドに明確な名前が付けられているか？）
• Comments（コメントは明確で分かりやすいか？）
• Style（コードはスタイルガイドに従っているか？）
• Documentation（関連するドキュメントは更新されているか？）

これに加えてコードレビューを適切に行うための「How To Do A Code Review」と、チェンジリスト記述者のための「The CL Author’s Guide」も用意されています。

今後さらに内容が充実していくのかもしれません。また、すでにこのドキュメントの日本語訳プロジェクト「Google's Engineering Practices documentation 日本語翻訳」も開始されているようです。