ソフトウェアにも140文字制限をいれると・・・

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

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

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

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

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

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