ユウト
本記事では、統一モデリング言語（UML）の代表的なものの一つである、クラス図の見やすい書き方とコツを紹介します。クラス図の書き方を知りたい人や、うまく書けない人は必見です。ぜひ参考にして、見やすく、より効果的なクラス図を書きましょう。
1. クラス図とは
クラス図とは、一言で言えば、システムの静的な構造や関係性を可視化する図のことです。可視化というところが最大のポイントで、3行からなる長方形から構成されています。
例えば、システム開発の仕様書が全て文字ベースだと、受け取る側も作成する側も大変な労力になります。それだけでなく、システムの抜けにも気付きにくくなりがちです。
しかし、クラス図は文字ではなく、図で表現しているうえ、記述方式が統一されているため、汎用性および保守性に優れています。それぞれの段に表記される項目は、最上段にクラス名、中段にクラスの属性、最下段にクラスの用いるメソッドや操作です。ソフトウェア開発者の間では広く用いられており、システム開発には欠かせない存在です。
2. クラス図のできること・メリット
クラス図を使うことで、具体的にどのようなできることやメリットがあるのでしょうか？ここでは、クラス図を作成する意義を紹介します。ぜひ参考にして、どのようなできることやメリットがあるか知りましょう。
2.1 構造を可視化できる
クラス図を作成することにより、システムの全体像をシンプルに構造化、図式化できます。構造化、図式化することで、システムの構造が複雑でも理解しやすくなります。
また、クラス単位での説明が可能になるため、ビジネス観点でシステム開発の方針や工数のすり合わせも可能です。
2.2 コミュニケーションが取りやすくなる
クラス図を使用することで、コードや専門的な用語を使わず、システムの概要を表現できるため、非技術者の関係者やクライアントとのコミュニケーションが取りやすくなります。
例えば、コーディング前にシステムの全体像を共有したい場合、クラス図のような統一されたものがないと、どのように書いたり説明したらいいかわからなくなります。
技術者の常識は、非技術者にとっては常識ではありません。技術者がわかるように作っても、非技術者には通用しない可能性が高いです。一方で、クラス図は非技術者とのコミュニケーションを想定して作られたものですので、安心して使用できます。
2.3 認識のズレや無駄を省ける
クラス図を使用することで、認識のすり合わせの精度や効率が大幅によくなります。知識やスキルの違いに関係なく、同じ土俵で議論することが可能です。
技術者の感覚からすれば、これぐらいのことはわかっているだろうと思っていることも、非技術者や経験の浅い技術者にとってはそうでないことが多くあります。
実際にこの認識の違いが後に大きな無駄を生むことになってしまいます。クラス図を活用することで、認識のズレがなくなり、大きな無駄やコスト増を防ぐことが可能です。
3. クラス図の書き方を解説（キャプチャ付）
ここでは、クラス図の具体的な書き方を紹介します。
クラス図は、上の図のように3段の長方形で構成されます。今回は分かりやすく、車についてのクラス図を作成してみます。
上の図のように、クラス名を洗い出し、それぞれの属性、操作を書き出していきます。その後、クラス同士の関係性を矢印で結びます。
この場合、「バス」、「トラック」は「車」に依存しているという関係性です。属性や操作に書かれている「＋」と「ー」の意味はそれぞれ以下になります。「＋」＝全てのクラスからアクセス可能；「ー」＝次クラスからのみサクセス可能
また、クラスを結ぶ矢印の形で意味が変わってきます。矢印の意味は以下になります。
（参照：https://cacoo.com/ja/blog/how-to-write-class-diagram/#i-5）
クラス図を作成するには、用語の意味だけでなく、矢印の意味も知っておくことが必要です。
4. 見やすいクラス図を書くためのコツ
せっかくクラス図を作成しても、他の人が見やすく、理解できるものでなければ意味がありません。それでは、みんなが見やすく、理解しやすいクラス図を書くためにはどのようにしたらいいのでしょうか？
ここでは、見やすいクラス図を書くためのコツを紹介します。
4.1 グルーピングする
クラスを適当に配置するだけでは見にくいので、クラスの機能や役割に応じてグルーピングしましょう。
グルーピングは一つのグループを四角でくくり、グループの名称を記載します。グループ数が多くなる場合は、グループごとに一つのクラス図を作成すると、さらに見やすくなります。紙に印刷してみて、小さくなりすぎないぐらいの量を一枚に収めるようにしましょう。
4.2 線を多用しない
線を多用しすぎると、クラス図が複雑になりすぎて見にくくなります。その原因としては、汎用的なクラスや共通で使用するクラスについても、全てに線を引いてしまっていることにあります。
汎用的・共通的なクラスは複数箇所で使用することが前提ですので、線を引かなくてもクラスの本質は掴むことが可能です。そのため、あえて線は引かず、シンプルにまとめた方が見やすく、わかりやすいクラス図になります。
4.3 ストーリー性を意識する
クラス図はストーリー性がわかるように、あるルールを守ると見やすくなります。具体的なルールは以下になります。
- インターフェースや基底となるクラスは上に、継承する側のクラスを下に配置する
- 使うクラスを上に、使われるクラスを下に配置する（または、使うクラスを左、使われるクラスを右に）
上記のルールに加え、プログラム実行順で初めに動く方が上にあった方がわかりやすいです。このようなルールを設けていないと、クラス図のどこから見始めたらいいのか分かりづらく、その上見にくくなってしまいます。
5.クラス図を簡単に作成できる無料ツール
クラス図などの図を作成できるツールの中でも、今回は無料デザインツール「boardmix」を紹介します。無料でありながら、さまざまな機能を備えており、クラス図に限らずさまざまな図の作成に適しています。ぜひ参考にして、一度使ってみてください。
5.1 boardmix
boardmixは、オンラインホワイトボードによって、共同での編集や閲覧を可能にしています。特徴は以下になります。
- 無料で使用可能
- 他社にはない機能性
- オンラインでの共有が可能
- シンプルな設計
- 直感的な操作性
- チームでの共有・編集が可能
上記のように、boardmixは無料でありながら、さまざまな機能を備えています。無料ですので、導入費用が発生せず、アカウントさえ作れば、いますぐにでも使用可能です。
5.2 boardmixの機能性
今回は、さまざまあるboardmixの機能性の中でも、最初から用意されている多彩なテンプレートについて紹介します。
上の図のように、デフォルトで多くのテンプレートが用意されています。
クラス図はもちろん、その他の図や資料も簡単に作成することが可能です。テンプレートを使うと、最初からある程度の形ができているので、作業時間が短縮できます。
他のメンバーとの共有も可能で、共同で編集も可能なうえ、自動保存ですので、保存し忘れによる無駄なやり直しも防ぐことができます。
6. まとめ
本記事では、見やすいクラス図の書き方やコツを紹介しました。内容をまとめると以下になります。
- クラス図はシステム開発に欠かせない
- クラス図を使用することで、チーム全体で正確な共有がしやすくなる
- クラス図を書くコツを知っておくことで、見やすいクラス図が作成できる
- 無料デザインツールboardmixの使用で、すぐに簡単にクラス図が作成できる
クラス図を使用することで、チーム全体での正確な共有が可能になり、無駄やコスト増をなくすことができます。しかし、見やすく分かりやすいクラス図でなければ意味がありません。ぜひ参考にして、見やすく分かりやすいクラス図を作成しましょう。
