一昨日の更新記事ですが、結構な人数の方に読んでいただけたようです。数えたことないのですが、おそらくこのブログをやってきた中で一番ではないかと思います。Twitter方面からの来訪者が多かったようです。ありがたいことです。
こういったものは瞬間最大的に増えるのですね。気づいた時にはほぼ元の状態に戻っていました。昨今のインターネットにおける情報の流れる速さについて行けないオッサンブロガーがここにいます。ついて行こうとしていないので当たり前だと思います。
まあしかし、はてなブログの『アクセス解析』くらいはもうちょっとマメに確認していこうかなと思いを新たにしました。今回も危うくスルーしちゃうところでした。
さてでは、一昨日の記事を書く時に、イマイチまとまらんなあと思って削除した内容をあらためて書いておこうと思いました。初志は曲げるためにあるものだと思っています。
一昨日の更新記事を読んでいただいた方々のほとんどには届かないと思いますが、それでもアクセス数が多かったのでうれしくて調子に乗っています。
ぼくのかんがえた『すぐれたドキュメント』(異論OK)
『優秀なエンジニアは優れたドキュメントを残す』らしいですが、この『優れたドキュメント』とはいったいどのようなものでしょうか。ワタクシの思うところはズバリ、
- その分野の基本的な素養がある人が読めば、作成した人の思考やヒラメキをトレースできるもの
ではないかなと思っています。結果だけではなく、そこに至る道筋も大事です。
「ドキュメントを残すのは他人のためにあらず、すべては自分のためである」という考えと矛盾する気もしますが、そこはあらかじめ思考停止でいきます。
別に体裁が整っていなくても良いし、絵やグラフが綺麗でなくても良いです。少々暴論かもですが、意味が通じて不快でさえなければ、文法がおかしくても良いと思います。(しかし文章が綺麗なものは優れたドキュメントであるものが多いという傾向はあると思う)
ですので例えば、コメントがいっぱい書かれているプログラムやラダー図も、裏紙に走り書きされたメモも、『優れたドキュメント』と思えるものは多くあります。
上層部にアピールするために作られた魅せる資料は、綺麗で分かりやすいけどちょっと違いますよね。そういった資料を持ってきて「これ読んだらだいたいわかるよ」なんて言って去っていくような人もたまにいますが、これは要注意なパターンですね。
で、理屈で考えるとですね、自分の思考や実行内容をトレースできるような資料を作りたいわけですから、日々常にアウトプットをしていけば良いだけと言えるはずなのです。
考えたことをすぐ文章化する。手を動かして得た知見は要点もメモる。実験は結果だけでなくその過程も残すように心がける。そうすれば改めて作成するまでもなく、気付けば良質なドキュメントができていることになります。実際そのようにして良質なドキュメントを残している方は多くおられます。
しかしワタクシ、これができない。やりたいのにできない。圧倒的にできない。もうやだホントやだ。
脳ミソがマルチタスクに向いていないのか、考えるスピードとアウトプットするスピードの差の問題なのか、はたまた考えがまとまらないうちに別のことを考え始めてしまうからなのか、いろんな要因は思い浮かびますが、そしてその上で努力もしているつもりですが、でもいつまで経っても改善の兆候は見られません。
できる人たちはいったいどうやってこのスキルを獲得したのでしょうか。やはりできる人はナチュラルボーン『できる人』なのでしょうか。ならばそこには一生超えることができない壁があるのでしょうか。もうやだホントやだ。
まあ、天才肌の人と張り合おうとは思いませんが、自分が納得いくドキュメントを作れるようにはなりたいわけです。やはり練習あるのみなのかしら。
相変わらず、優秀なエンジニアへの道は果てしなく長いということです。
