意識の低いエンジニアのドキュメント


様々なエンジニアとの出会う
自分が所属する組織や他の組織まで越境して様々なレビューに関わると、多種多様なタレント性を持ったエンジニアと会う機会を貰える。組織の中とはいえ、そこそこの人数になると会う人は限られてくるから、例え、顔見知りだったとしてもレビューをとおして仕事をすることは初めてだったりすることが少なくない。エンジニアも組織の中という環境で育つことから家風や文化という見えない力に少なからず不思議と左右されているものだ。とは言っても、である。例えはドキュメントのレビューの場合は、それを書いた本人がレビューアとして説明することになるから、そのエンジニアのドキュメントに対する理解度と振る舞いを知ることとができる。


書いた本人が理解していない
不思議思うだろうか、ドキュメントを書いた張本人のエンジニア自身が書いたドキュメントにどれだけ理解しているかどうかということを。事実、よくあるのだ。書いた本人が、何を書いたか理解していないということを。たとえば、このようなことがあった。

レビューア「このプロジェクトのスケジュールを説明して。」
レビューイ「これがこうなって、次にあれが...」
レビューア「そのタスクは、なぜそのタイミングで始めないといけないの。」
レビューイ「ええっと、なんででしたっけ?」
レビューア「質問に質問で返すなよ。」

レビューイのエンジニアが自分で情報を集め、自分の頭で考え、書き出したのなら、説明できないことなんてありえない。少なくとも、自分で理解できているならその理解した内容を応えられるものだ。そのドキュメントが過去の資料などの他からの再利用であったとしても、一度は自分の頭の中で消化していれば、そのようなことは起きない。つまり、情報の寄せ集めであったとしても、過去の資料の再利用であったとしても、自分が頭の中で考え、理解した上で作成するドキュメントなら自信を持って説明できるのだ。


理解していないのはなぜか
なぜ、エンジニアが自分で書いたドキュメントに対して、理解が不足するようなことになるのだろうか。いくつがケースが考えられる。一番の要因は、どのドキュメントに書かれたことの当事者意識が欠如しているのではないか、ということが考えられる。自分自身がそのドキュメントに書かれたことをレビュー後に実行すると仮定を置いたら、そのドキュメントの細部にまで気を配るものだ。今気を配っておかなければ、実際にやるときになって初めて考えることになり、今時点で識別できたリスクとそのエクスボージャを先送りすることになってしまう。今なら些細なことでも、明日になれば、状況は変わっていて当然なのだ。当事者意識の欠如は、責任の所在を蔑ろにしているということでもある。自分自身がやらないのだから、今、リスクを識別するなんて面倒なことは、これを実行する他のエンジニアなのだからその人が考えればいいのだ、と。こういった考えを口にも出して憚らないエンジニアもいることは確かなのである。
いずれの場合も“自分がやらない”という低い意識からであり、その様な考えを基にするドキュメントは問題が少なくない。






  • 道具室(アプリとか)

今日は、鞄に本が入っていない。


  • 音楽室(PCからリンクをクリックするとき、PCにiTunesが入っているとアプリケーションが起動します)



  • 視聴覚室
  • 調達室