優秀なエンジニアは優れたドキュメントを残すらしい

『優秀なエンジニアは優れたドキュメントを残す』と、大学生の時に隣の研究室の先生に言われたことがあります。説教めいた話をされておられたような記憶があり、てっきり格言のような有名な文言かと思っていましたが、検索してもこれといったものは出てこないようです。ということはあの先生のオリジナルだったということでしょうか。

説教めいた話がどんな内容だったかはすっかり忘れてしまいましたが、この言葉だけは結構強烈に印象に残っています。言ってることは本当にそのまんまで、自分がやったことはしっかりドキュメントに落とし込むまでがやらなければいけないことだよ、ということです。社会人になってからも似たようなことを言われました。ワタシの中には、優秀なエンジニアになりたいという気持ちもありました。

しかし、優れているかどうかは置いておいたとしても、ドキュメントを作成するという行為は極めて不得意です。社会人なりたての頃は、『優れたドキュメントを残すことが条件であるならば、優秀なエンジニアでなくても良い』とさえ思っていました。『自分さえ分かっていれば少なくとも自分が困ることはない。なぜ他人のために時間を割いてドキュメントを作らねばならないのか。他人が困っても別に関係ない』くらいの気持ちになってた時もあります。若いってイタイことですね。
今現在、それほど若くなくなって考えが変わったかというと、実はあんまり変わっていません。あいかわらず他人のためにドキュメントを作ろうというモチベーションはありません。しかし、ドキュメントを作っていこうという意思は今かなり大きいです。なぜか。

  • ドキュメントに残すという作業を怠ったがばかりに、自分の中に技術的な知見として吸収しきれていないことがある(と最近気付いた)
  • 他人に昔の実績を説明しないとならないことが稀にある(歳をとったものである)
  • マネージャーになって実務から遠ざかったから、手足を動かして実績を積むことがなくなってきた(その寂しさを紛らわしたい)
  • 生きている証を時代に打ち付けたい

たいへんエモい話ですが、最後のが一番大きな動機であり、かつその他の理由も結局は集約される部分があると思います。要は、ドキュメントを残すということは他人のためにあらず、全ては自分のためであるのだ、ということに気付くのにかなり時間がかかってしまったということです。

ということで、今なら偉そうに『優秀なエンジニアは優れたドキュメントを残すのだよ』なんて他人にも言えちゃえそうな気がしています。
ただやはり今まで怠ってきたツケはすごくあって、ドキュメントを作ることに対する苦手意識はなかなか拭えません。優秀なエンジニアへの道のりは遠いです。

あんまり関係ないですが、『I'll be…』はミスチルの曲の中でもトップを争えるくらい好きな曲です。

I'LL BE

I'LL BE