Help us understand the problem. What is going on with this article?

カロリーゼロ食品から思い浮かべるもの ~暗黙的な概念は伝わらない~

More than 5 years have passed since last update.

はじめに

変なタイトルですみません。

言いたいことはカロリーゼロ食品の味がどうこうではなく、 暗黙的な概念は伝わらないので、重要な概念は明示的に表現すべき ということ。

動くソフトウェアではなく、動き続けるソフトウェアを作るため には、重要な概念をきちんと表現すべきだと思っている。

普通の食品とカロリーゼロ食品の違い

私は普段カロリーゼロ食品を食べないので正確な違いはわからず、「味が違うんだろう」「ダイエットに向いているのではないか」くらいなことしか思い浮かばない。しかし 実は恐ろしいゼロカロリーの秘密 という記事を読むと、他にも以下のような違いがあることがわかる。

  • 太りやすい体質になる。

  • 味覚が鈍化する。

他にも違いがあるが省略する。ここではその違いの真偽や良し悪しについて言いたいわけではない。主張したいことは 「カロリーゼロ食品」という単語から、そういった暗黙的な違いを全て汲み取ることができるのか? ということ。私には無理。

ソフトウェア開発の現場では

ソフトウェア開発の現場でも同じようなことが起こっている。例えば新入社員や他部署からの異動者に、アプリケーションの振る舞いを正確に伝えるドキュメントがあるだろうか。私の経験ではそんなドキュメントは存在しない。理由は様々だろうが、私の現場では以下のような理由からである。

  • ドキュメントに書かなくてもレビュー時に口頭で説明できればレビュー合格とする文化のため、ドキュメント作成者がドキュメントに書くべき内容を意図的に省く。

  • 評価時に出た不具合の修正内容をドキュメントに反映しないため、ドキュメントとコードの内容に差異が生じる。

それならドキュメントなんか信用せず、コードを見れば良いじゃないかと思うかもしれない。しかしそのような現場ではコードでも重要なことは表現されていない。

例えば下記のような、運送料を計算するコードを考える( C#実践開発手法 から引用 )。

sample.cpp
class Size { /* ... */ };
class RegionInfo { /* ... */ };

int calculateShippingCost(
        float packageWeightInKilograms,
        const Size& packageDimensionsInInches,
        const RegionInfo& destination)
{
    // 運送料を計算する処理
}

運送料を計算するアプリケーションで重要と思われる概念(重量、金額)が float 型、 int 型になっていることで、以下のような問題が生じる。

  • SizeRegionInfofloatint のレベルが揃っていなくて気持ち悪い。

  • 重量や運送料は負の値を取らないはずなので calculateShippingCost に事前条件と事後条件を追加する必要があり、運送料を計算するロジックが埋もれてしまう。

  • calculateShippingCost 以外にも重量や金額を扱う箇所で値の検証をする処理を記述しなくてはいけない。

これは WeightMoney 型を導入すれば解決する。

では、どうしたら良いのか

  • 重要な概念などはコードで伝える

設計とはコードがどのように振る舞うかを規定したものであり、それはコードで表現するものだ(アプリケーションは仕様書の記載通りに動作するわけではない)。コードで記述するものをドキュメントでも記述するのは時間の無駄だと思う。それよりは振る舞いの背景にある意図など、コードで記述できないことを補うためにドキュメントを利用する方が良い。

  • 一度で完璧な設計をしようとしない

PHPカンファレンス2015PHPメンターズセミナー「モデルをお設計せよ!-ドメイン駆動設計を超えて」 の発表で 実装力 = 全てを切り拓く力 とあったが、その通りだと思う。設計とコーディングを分けて考えるのではなく、ドメインモデルを設計しながら実装/実装しながら設計を実践することでより良い設計に近づけるのではないかと思っている(こういう考えを ドメインコーディング と呼ぶらしい)。

  • いろいろな視点を持つ

一枚の写真や一つのニュース記事などから受ける感想は各個人異なる。これは各個人が異なる視点で物事を見ているためだ。様々な視点で物事を見ることができれば、暗黙的な概念を引き出すことができるかもしれない。PHPカンファレンス2015PHPメンターズセミナーの発表では、 もし〇〇だったらどうか という風に様々な仮定を設定すると今まで見えなかったことが見えるようになるかも...とのアドバイスがあった。

まとめ

  • 自分の意図していることを正確に伝えることは難しいので、伝えたいことは明示的に表現すべき。

  • 相手の主張したいことを掴むために、様々な視点を持つべき。

参考

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away