2008/08 / 08

ドキュメントに残すということ。

第一回は仕事能力のお話。

仕事能力と一言に表現しても、色々ありますよね。
キレイなソースコードを書く能力、乱雑な情報もスッキリまとめることが出来るデザイン能力。軽くてバグの少ないプログラムを作る能力。相手に物事を上手く伝える事も仕事能力の一つです。

そんな中で僕が特にあこがれる仕事能力は、「作ったものをドキュメントに残す」力です。

素晴らしいソースコードを書く人や、バリバリ最先端の技術を使いこなす人もカッコイイです。しかし、どんなに素晴らしい物でも、作った人以外は管理が出来ないような物だったらどうでしょう?
それは職場の仲間やクライアントさんにとって優しい物であると言えるでしょうか?

会社という組織の中でチームを組んで仕事をしていく上では、個人の作ったものがどんなに素晴らしいものでも、それを共有し、みんながカスタム出来る物にしなくては商品にはできません。そうなってしまうと、折角あなたが作った素晴らしいプログラムや斬新で革命的なデザインも、その価値は激減してしまいます。逆に簡単には理解する事が出来ない複雑なプログラムでも、ある程度のガイドラインがあれば、それがはじめて触るものでもなんとなくのカタチを掴む事が出来ます。

つまり、「ドキュメントに残す」行為は、あなたの作ったものの利用価値を高めてくれるのです。

これを事を常に考えながら仕事をすると、いつもの仕事も違った物に見えてきます。「この作り方は、後からカスタムする人にとって親切な作りのかな?」という職場の仲間への愛(?)も芽生えてきます。ソースコードの1行でも、あとで見る人が読みやすいようにという意識を持ってコードを書くと、不思議とシンプルでわかりやすいソースが書けるようになっていきます。

また、自分自身の作ったものを客観的に評価できる良い機会にもなります。もしも作ったものに対して上手に説明できないとしたら、それは自分の理解が足りていないという事になりますし、キレイにまとめられないという事は、作る時のルールづけがしっかり出来ていないという事になります。ドキュメントを作る過程で、今の自分に何が足りないのかを再確認出来ます。

ドキュメントに残すという行為は、クライアントさんや同じ職場の仲間への思いやりでもあり、理解力を深める良い機会でもあります。もしも、職場の誰もが簡単に理解できるような「説明書」を作れたとしたら、あなたはきっとその分野のスペシャリストになっているはずです。

そうした愛にあふれたスペシャリストになるべく、今日もドキュメントと格闘するのです。

return to page top