メインコンテンツへスキップ
見出し画像

UMLの使われ方が変わった理由。問題は『図』より『実装とのズレ』

    設計書にクラス図や処理フローがあると、それだけで少し安心できます。

    ところが、仕様変更後も図だけが以前の状態で残っていると話が変わります。図ではAからBを呼び出しているのに、実際のコードではAからCを経由している。レビューする側が古い図を前提に確認すると、実装の意図を取り違える可能性もあります。

    設計書は、実装と合っている間は確認材料になります。ズレたまま残ると、今度は判断を間違える原因になります。

    UMLを考えるときは、この「維持する手間」を外せないと思っています。

    UMLそのものが使えないわけではない

    UMLは、ソフトウェアの構造や処理の流れを一定のルールで図にするための記法です。

    クラス同士の関係を表すクラス図、処理の流れを表すシーケンス図、利用者とシステムの関係を整理するユースケース図などがあります。

    以前は、ソフトウェア設計を学ぶ中でUMLをかなり重視する時期もありました。「設計するならUMLを書く」という扱いを受ける場面も多かったと思います。

    ただ、UMLそのものに問題があったというより、設計図を細かく作り、それを常に最新状態へ保つ運用の負担が大きかったのではないでしょうか。

    仕様が変わればコードを直します。

    レビューで設計が変われば、またコードを直します。

    その変更に合わせてクラス図、シーケンス図、ユースケース図まで修正していくと、設計資料の維持にも時間が必要になります。

    仕様変更が多い開発ほど図が古くなりやすい

    ゲーム開発やWeb開発では、実装を進めながら仕様が変わることがあります。

    画面を作って操作してみた結果、使いにくいので仕様を変える。負荷テストをした結果、処理方法を変更する。レビューで責務の分け方を見直し、クラス構成を変える。

    こうした変更自体は珍しくありません。

    問題になるのは、コードだけ変更され、設計図が以前の状態で残ることです。

    数か月後に別の担当者がその図を見ると、「この処理はこの構成なのだろう」と判断します。ところが実装を確認すると違います。

    そうなると、設計図を信用してよいのか、それともコードだけを確認すればよいのかから調べる必要が出てきます。

    図を詳しく書くほど情報量は増えますが、修正する場所も増えます。

    詳細なクラス図や大量のユースケース図が以前ほど使われなくなった背景には、この維持負担もあるのだと思います。

    それでも図が必要な場面は残っている

    すべてをコードだけで確認すればよいわけでもありません。

    たとえばDDDでは、Bounded Context同士の関係やAggregateの境界を図にした方が、担当者同士で認識を揃えやすい場面があります。

    シーケンス図も、複数のAPIやサービスが関係する処理では役立ちます。

    「画面からAPIを呼ぶ」
    「認証サービスを確認する」
    「DBを更新する」
    「外部サービスへ通知する」

    こうした処理をコードだけ追うより、呼び出し順を図にした方が、どこで失敗する可能性があるのか確認しやすくなる場合があります。

    金融、医療、組込みなど、安全性や変更履歴の追跡を重視する領域では、設計資料を細かく残す必要もあります。

    UMLを使うか使わないかではなく、その図を何の判断に使うのかまで決めておいた方が扱いやすくなります。

    PlantUMLやMermaidならコードと一緒に管理しやすい

    現在はPlantUMLやMermaidのように、テキストから図を生成する方法もあります。

    画像ファイルを直接編集する方法と違い、Gitで管理すれば変更差分を確認できます。

    Pull Requestで、

    「APIの呼び出し順が変わった」
    「クラス間の依存関係が変わった」
    「サービスが一つ追加された」

    といった変更を、コードの修正と一緒に確認しやすくなります。

    もちろん、テキスト化しただけで図が自動的に最新になるわけではありません。コードを変更したのに図を直さなければ、やはりズレます。

    それでも、設計資料だけ別の場所に置くより、コードと同じ変更単位でレビューできる方が修正忘れには気付きやすくなります。

    設計図を残すときに確認したいこと

    図を書くか迷ったときは、「正式な設計書を作るか」から考えるより、何を確認するための図なのかを見る方が判断しやすいと思います。

    ・コードだけでは関係を確認しにくい部分なのか
    ・仕様変更のたびに更新できる量なのか
    ・実装変更時に、図の修正もレビュー対象にできるのか
    ・半年後に見た人が、その図を最新版だと判断できるのか
    ・詳細なクラス構造まで必要なのか、それともサービス間の関係だけ分かればよいのか

    図をきれいに仕上げることより、実装担当者、レビュー担当者、テスト担当者が同じ構造を見て確認できる状態を作る方が扱いやすいはずです。

    必要なところだけ軽く描く。変更されたら直す。不要になった図は残し続けない。

    UMLもPlantUMLもMermaidも、そのくらいの使い方でよい場面はかなりあると思います。

    おわりに

    設計図があるかどうかだけでなく、「今の実装と合っているか」を確認するところまで含めて設計資料を見る必要があります。レビューするときも、図そのものより、コードとの差分を確認できる状態になっているかを見ておきたいところです。

    開発や採用、育成、マネジメントについて、日々の仕事の中で考えたことはX・Bluesky・Facebookでも投稿しています。
    noteの記事にするほど長くない話や、日々の仕事で気になったことも書いています。

    X:https://x.com/itchie_tatsumi
    Bluesky:https://bsky.app/profile/itchie-tatsumi.bsky.social
    Facebook:https://www.facebook.com/ichino.souta

    また、辰巳電子工業SS事業部では、エンジニアが安心して長く働ける環境づくりを進めています。

    設計や開発の仕事だけでなく、案件の選び方やキャリア、働き方について話を聞いてみたい方は、事業部のWebサイトもご覧ください。カジュアル面談についてもご案内しています。

    https://www.tatsu-mi-systemsolution.jp/

     
     
    辰巳電子工業の事業責任者。ゲームPG⇒ゲーム会社取締役⇒現職。ゲーム/システム開発、エンジニア組織づくりの現場で見てきたことを元に、若手育成、働き方、技術情報を整理して発信します。ゲーム業界志望の方、ITエンジニアとして働きたい若手や、マネジメントを目指す方に向けたnoteです。

    あなたへのおすすめ