森崎修司の「どうやってはかるの?」:ITmediaオルタナティブ・ブログ (RSS) 森崎修司の「どうやってはかるの?」

計測できそうでできない多くのこと。エンピリカル(実証的)アプローチで。

Twitterは文字数の制限で、挨拶、気配り、「本来ならば・・だけれども~」的表現をする必要がない(現実にはその文字数がないだけで、気持ちではそうしている)ように思う。「文字数の制約があるからだろうな」と読み手に考えをめぐらせる効果があるからだと思っている。また、書き手は文を短くしないといけないため、あまり重要でなかったり、補足的な説明部分を削除したりするなどの工夫をする際に、文を推敲しているように思う。結果として、本質的な部分を残しつつ、そこそこ円滑なコミュニケーションができるのではないかと考えている。

ソフトウェアでもドキュメントやソースコードのコメント部分に説明が記述される。規模が大きいとどうしても推敲が不十分になってしまう。そこで、文字数に制約をつけた部分を作ってみるというのはどうだろうかと思った。ドキュメント全体を140文字にしたりすると、なんとなくうまくいかない気がするので、以下のような部分に制約をつけてみてはどうかと思った。

  • 設計ドキュメント
    ある機能の機能名の直後に140文字以内でそれをもっとも端的に表す説明をいれる。
  • ソースコードのコメント
    1メソッド、1関数あたり140文字以内でそのメソッドや関数を端的に説明するコメントをつける。

140文字に拘る必要はなく、200文字としても効果が上がるように思う。設計ドキュメントであれば、言い訳っぽい話や2つ以上のことを1つの機能の説明につめこんでしまうことが減るように思う。コメントからは「// 変数の初期化」というような読まなくてもだいたいわかるような説明が減るように思う。

書いた文をきちんと見直すことが常に習慣づけられ、かつ、低コストでできるようになればよいのだが、文字数の制約はそれをうまく実現させる方法のように感じる。

あまり制約をつけずに書いてしまったコメントだと、空白行のほうが役に立つというような調査結果になってしまうのではないかと思う。この調査の詳細はこちら(当ブログの過去エントリ)へ。

森崎

Special

- PR -
コメント

コメントを投稿する
メールアドレス(必須):
URL:
コメント:
トラックバック

http://app.blogs.itmedia.co.jp/t/trackback/77444/23609196

トラックバック・ポリシー


» このブログのTOP

» オルタナティブ・ブログTOP



プロフィール

森崎修司

森崎修司

ソフトウェア開発に携わる方に気づきを提供することを目指し、ソフトウェア開発の定量化/効率化/高品質化の動向を国内・海外、実務・研究から多面的に紹介し、研究者の視点、自身の業務経験をふまえた視点から考察します。現在、静岡大学 助教

詳しいプロフィール

カレンダー
2012年2月
      1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29      
カテゴリー
エンタープライズ・ピックアップ

news094.gif 富士通元社長の山本卓眞氏が残した次代へのメッセージ
富士通の社長、会長を務めた山本卓眞氏が亡くなった。哀悼の意を込めて、日本のIT産業界の大御所が残した次代へのメッセージを紹介しておきたい。(2/6)

news094.gif Facebook就活はもう古い?
約260人のブロガーが、ITにまつわる時事情報などを日々発信しているビジネス・ブログメディア「ITmedia オルタナティブ・ブログ」。その中から今回は「就活」「都心の雪」「ソーシャルメディア」などを紹介しよう。(2/4)

news094.gif 東北をコットンの生産地としてブランディングしたい──リー・ジャパン・細川取締役
塩害に強い綿の生産で東北に新たな産業を作りたい。オーガニックコットンの採用など、環境負荷を下げるジーンズ生産に取り組んできたリー・ジャパンの新たなチャレンジとは──。(1/30)

news094.gif 東北から始まるイノベーション
企業のICTを活用と若手IT技術者による東北発のイノベーションが、中長期的な震災復興の鍵となる。(1/27)

news094.gif 貧困国の雇用を創出する印刷屋、丸吉日新堂印刷の挑戦
全国から約2万7000件の名刺制作を受注をする札幌の小さな印刷会社の成功の秘密は、地道な社会貢献にあった。(1/16)

オルタナティブ・ブログは、専門スタッフにより、企画・構成されています。入力頂いた内容は、アイティメディアの他、オルタナティブ・ブログ、及び本記事執筆会社に提供されます。

Special

- PR -

サイトマップ | 利用規約 | プライバシーポリシー | 広告案内 | お問い合わせ