答えを聞くエンジニア - 室長のひとりごち

どう書けばいいですか。
日々、色々なレビューをしていると資料を受け取る顧客、ドキュメントを作るエンジニア、それを一次レビューするマネージャ、そして文書内容は都度違うので、その文書の目的に沿ったコメントする。そのレビューでは、本当にさまざまなことを言う。そのレビュー対象の文書の位置づけにより、一つのことを言うにしても状況や立場により、相応しい表現があるからそれを汲み取り、あっていなければそれを伝えることになる。
コメントの仕方も、組織の中で具体的なガイドラインがあればそれをリファーするし、ナレッジになっていればそれを示すし、経験からコメントすることもある。そのコメントも一字一句明示的に伝えることもあるし、リファー先のポインタまでのときもあるし、ニュアンスだけど伝えることもある。
レビューイである文書作成者はさまざまだ。経験の豊富なエンジニアもいれば、中堅のエンジニアもいる。経験する業務が違うから、育つ文化も違ってくる。だから、書き方、使う言葉、雰囲気など多種多様な文書に出会うことになる。
だから、そのレビュー対象となる文書に対してのコメントがさまざまになる。それは自然なことだ。
経験の豊富なエンジニアに対しては、組織のガイドラインの標準のような文言はそのものを示すが、表現などは一字一句までは言わない。それは、その文書を持って顧客と意思疎通するエンジニアが自分の口から発する言葉でなければならない。なぜなら、人の言葉では、その言葉の意味を指摘するレビューアの真意までは多分に理解ししていないことが多いし、理解していない言葉で他人の言葉を使うことは、顧客からの問いかけに自分の言葉で返すことができないからだ。
それをわかっていないエンジニアは、何ら疑問も持たずに聞く。

「どう書けばいいですか。」
「言ってくれたらそのままタイプしますから。」

アドバイスは、アドバイス
レビューアは、レビューアであって、文書へコメントするが、顧客の前に行ってコミュニケーションを取る当事者ではない。レビューアがマネージャで、エンジニアと帯同するのであればコミュニケーションの中に入るが、そうでないこともある。その点から言えば、レビューアが文書へコメントするのは、アドバイスにしかならない。

もともと、文書レビューはレビューイがレビューポイントをレビューアに伝えて行なうものだ。何を見て欲しいのかは、レビューイが知っている。その文書をどのように見て欲しいか、どのように直したいかはレビューイしか知らない。レビューポイントはレビューアに伝えても、言葉という繊細な記号の選択のニュアンスは伝わらない。
その逆も然り、レビューアは、レビューポイントに沿ってコメントを残すが、情報が等価でないないところでの文書の上に重ねるコメントであるから、言語を理解してずれていくレビューアのニュアンスまではレビューイには伝わらない。

レビューポイントを共有してもその文書に責を負うのは、レビューイであってその用途を正しく理解しているのも当事者のレビューイであるから、最終的にどのように表現するかはレビューイに選択権がある。それは、レビューアのコメントはあくまでもアドバイスでしかない。

何をするかはエンジニアが決めること
レビューアのコメントは、アドバイスでしかないから、どのコメントを採用するか、取捨選択するのはエンジニアが決めることである。文書の位置づけと採用する言葉のニュアンスの理解は、レビューイであるエンジニアでしかわからない。それは、エンジニアに委ねられている。