未来の自分を信頼し過ぎない


プログラミングにおいて他者のことを考えて「分かりやすいコードを書きましょう」「適切なコメントをつけましょう」というのは基本的なことです。
この「他者」には、そう遠くない「未来の自分」も含まれています。が、けっこう忘れてしまいがちです。

色々な理由で一度は終了した(あるいは自分だけでも抜けた)プロジェクトに関わることがあったりします(バグの修正やちょっとした調査などです)。また同じプロジェクトでも、プロジェクトの期間が長ければ、色々な機能に携わっていきます。

プログラミング以外にも自分用メモやちょっとした資料を作ることも多くあります。
その時に「(今は)余裕で分かっているから」と手を抜いて書くと、未来の自分が見た時に「??」となり、有り難みのない(時には惑わしてしまう)ものになってしまいます。

なので、未来の自分(の記憶力)を信頼し過ぎないで、未来の自分が説明不要でも分かるプログラムや資料を作るのを心がけましょうと。
それが結果として(未来の自分も含んだ)他者にとって良い資料となり、仕事の質も上がることにつながると思います。

もちろん、限られた仕事の時間で全ての資料を丁寧に作る余裕はありません。
が、「これはまた使うな」や「この資料はちゃんと作っておけば楽になるわ」と近い将来のことを見通して行けばOKです。
#ついでに言うとこういう近い将来を見通していないと段取りが悪かったり、同じようなこと(資料やプログラム)を何度もしてしまったりします。

と、言うようなことを自分のメモにあった「タコ焼き」という一言に「??」となったので未来の自分に向けて書いておきます。

※注意:この記事は旧サウスポーなエンジニアの独り言から移行し一部修正したエントリです。

Photo via Visualhunt.com

未来の自分を信頼し過ぎない」への1件のフィードバック

  1. ピンバック: 文書化の指針 – サウスポーなエンジニアの独り言

コメントを残す