2006-09-17 diary: 某プロジェクトの火消しに参加中…

某プロジェクトの火消しに参加中…

新宿の某ビルに 9/14(木), 9/15(金), 9/16(土), 9/18(月) と緊急に集められています。

某プロジェクトの火消しに参加中

某プロジェクトの火消しに参加中です。新宿の某ビルに 9/14(木), 9/15(金), 9/16(土), 9/18(月) と緊急に集められています。 9/16(土)までは 設計書(ドキュメント)とソースコードの間の乖離をひたすらレビューし続けました。

さて、明日(9/18)も仕事、仕事。

設計書とソースコードは、双方いずれからでも該当箇所の相関関係が確認でき、また内容そのものも平易に読み解けるようになっているのが望ましいです

設計書とソースコードは、双方いずれからでも該当箇所の相関関係が確認でき、また内容そのものも平易に読み解けるようになっている状態が良いです。

私たちがプログラマーとして作業をする際に、いかに設計書の内容の仕様を簡単に・シンプルにソースコードとして実装するのか について いつも考えながらプログラミングをします。これは大切なことです。簡単な設計書からは簡単なソースコードが出来上がらなくてはなりません。複雑な機能を実現する設計書からは、その設計書の記述に従った 複雑な機能を実装したソースコードが出来上がらなくてはなりません。私たちは時として設計書の行間を読む必要はありますが、設計書と離れていった実装をしてしまうと、設計書とソースコードの行き来が平易ではなくなってしまいます。

真に優秀なプログラマーが書いたソースコードは、他人が初見でも容易に読み進めることができ、また場合によってはソースコードから設計書の仕様・設計書の書きっぷりが想像できる場合すらあります。ふだんから私たちは単純にそしてシンプルで平易に実装するように努めていくことにより、複雑な機能を実装する場合でも、それを実装することが可能になるのです。常にシンプルで平易な状態のソースコードが記述できる、そんなプログラマーに私はなりたいです。

なお、設計書とソースコードの関係を良好に保つ唯一の方法は、設計書とソースコードを並べた他者レビューであると考えています。最も適切なレビューは、紙の状態になった(印刷された)設計書およびソースコードが利用されます。これが最も良い方法です。(しかしコストがかかります)また、紙の設計書とソースコードとのあいだのチェックのためには、マーカーペンや色付きボールペンなど 塗りつぶし作業をするための道具が必要です。いずれにしても私の経験およびスキルにおいては、設計書・ソースコードの両方が紙の状態において、初めて質の高いレビューが実施できます。

この日記について

• ホームページ更新者: 伊賀 敏樹 / Tosiki Iga
• Diary / Facebook / LinkedIn / GitHub / Qiita / Mastodon / X(Twitter) / Amazon / Share on Twitter / top / いがぴょんについて / Powered by Igapyonv3
• 本サイトの見解は、私 個人のものであり、株式会社レザボア・コンサルティング は当個人的見解に一切責任を持ちません。