いろいろな仕事を渡り歩き、今はインフラ系エンジニアをやっている。いろんな業種からの視点も交えてコラムを綴らせていただきます。

お求めのドキュメントは書けません! Part4 --ひっこんでろ、くそれびゅー--

»

◾︎レビュアーという絶対有利な立場

 レビュアーとは絶対有利な条件だ。どんな名文であっても言いがかりを付ける事ができる。レビュアーの気に入る、気に入らないだけで判定を下すことができる。

 私のコラムに対するコメントも、レビュー結果とも受け取れる。読んだ人がレビューして、結果を書いているわけだ。その内容を見て分かる通り、感情に任せて書きなぐることもできるし、理論が破綻している人もいる。

 コラムであれば、伏線を潜めておいて反撃も可能だ。しかし業務では、どんなに理不尽なレビューをされても反撃は許されない。レビュアーが絶対的な審判。そういうやり方のレビューが主流だ。

◾︎もっと楽しくドキュメントを書こう

 とりあえず、ドキュメントを書く期限が決められる。内容は第三者に規定され、自分の意見を挟むことが許されない。その割に書くべき内容に対しての情報が錯綜している。不安いっぱいながら書いたドキュメントは、レビューの度にこき下ろされる。

 こういうところでドキュメントを書いていても、いつまでも書き上がる気がしない。時間に対してのクオリティーが驚く程に低い。ドキュメントが嫌いという人は、こうい環境がトラウマになっているのかもしれない。

◾︎レビュイ殺しの達人

 レビュアーのよく陥る間違い。それは、多く間違いを見つけることが良いレビューだと思い込むことだ。一般的な考え方であれば、レビューをするのは間違いを探すためだ。多くの間違いを見つければ「たくさん仕事をした」ことになる。

 だがその考え方自体が間違いだと私は思う。ただ間違いを探すのは、レビューではなく粗探しだからだ。「あなたのドキュメントに沢山間違いがありました!」で結論を締めくくってもドキュメントの質は上がらない。それどころか、モチベーションを削いで、逆に質が下がる。

 こういう勘違いをすると、頑張れば頑張るほど事態が悪化する。書いたドキュメントに駄目出しがたくさん付くのも残念だが、頑張るほどチームのモチベーションを削いでしまうというのも非常に残念だ。

◾︎そのレビューに意味があるか

 多く間違いを見つける → 事前に修正できる → ドキュメントの質が上がる。

レビューをする目的はズバリこれだろう。だが、レビューしていてこれが実現できているだろうか?間違いを見つけるだけ見つけて、その後の対策が抜けていないだろうか?修正するにしても、手元の情報がまとまっていなければ修正できない。

 見方を変えるなら、レビューとはヒアリングとも考えられる。その気しだいで、問題を探ったり、メンバーが何を不安に思っているか等、プロジェクトに有益な情報を多く聞き出すことができる。

 レビューというと嫌なイメージが(私は)先行する。だが、ドキュメントの質が上がるという目的が達成できるレベルのレビューを受けられたら、考え方が変わるかもしれない。そんな、レビュイがドキュメントを書くのが楽しくなるような、そんなレビュアーに私はなりたい。

Comment(0)

コメント

コメントを投稿する