タグ

docと抽象に関するkiyo_hikoのブックマーク (1)

  • コンテキストに沿い、インテントを持ち、セマンティクスを踏まえ、シンタックスに則る。 - とあるソフトの開発記録

    UMLの重要性は明らかだが、UML記法に従っていれば有用だと思われている節がある。文法的に正しければ良いわけではない。良いUML図とは、コンテキストに沿い、インテントを持ち、セマンティクスを踏まえ、そしてシンタックスに則っている。 最も大切なのはインテントを持つこと。あなたがなぜその図が必要だと思ったのかという意図を明確に意識する。そして、その意図が読み手にも伝わり、共感されなければならない。たとえば、「ソフトウェア構造」という章節にクラス図を配置したとする。しかし、どんな粒度の図がいくつ必要かはケースバイケースである。したがって、各図は「まず全体の設計を明らかにし」、「次に個別のパッケージ内の設計を明らかにし」、などというあなたの意図に基づいていて、図はそれを顕したものでなければならない。この点、テンプレをコピーしただけの文書で非常に見苦しいことが多い。 インテントは、書き手の意思だけで

    コンテキストに沿い、インテントを持ち、セマンティクスを踏まえ、シンタックスに則る。 - とあるソフトの開発記録
    kiyo_hiko
    kiyo_hiko 2012/03/26
    素晴らしい UML図だけでなく設計書など全般に通じる話
  • 1