13
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

LITALICOAdvent Calendar 2022

Day 24

ロバストネス図アレンジ版を使ってます

Last updated at Posted at 2022-12-24

はじめに

システムの全容をわかりやすい絵で表し、エンジニア・プロダクト担当者・インフラ担当者間で共有・議論できる何かがあれば便利ですよね。

そんな課題を解決する方法の1つとしてロバストネス(分析)図を紹介いたします。

ロバストネス図は、ユースケース駆動開発/ICONIXプロセスの中でも登場する図です。
これはユースケースによる要求を理解し、理解した要求から曖昧さを排除し、要求と設計とのギャップを埋めるものとしています。
言い換えると、プロダクト側担当者の要求と、エンジニアの設計書を結びつけるための表現方法であるということです。

私はこの手法を長年愛用しておりまして、いくつかのアレンジを加えてきました。
なのでここで紹介するロバストネス図は、一般的なものとは異なっているのでご了承ください。

この記事はどんな人に読んでもらいたいか?

こんな思いがある方がいたら、本記事はお役に立てるかと思います。

  • ICONIXプロセスに興味がある人
    • 興味なくてもOK! 自分も最近までそういった開発手法の中にあるものとは知らなかったので
  • UML好きな人
    • 好きでなくてもなんとなく分かるレベルでも良いです。
  • システムの設計を行う人
    • そして、たくさんの設計書を書くのがめんどいと思う人。不真面目な人
  • 工数見積もりを行う人
    • 考慮漏ればかりで実際に開発に入ると2倍以上の工数がかかる・・・のあるあるを経験したことのある人
  • プロダクト側の人と何を作るか話しをしたい人
    • ユースケース図を書いて見たが、丸(○)ばっか繋げてなんか意味あるの?と思った事がある人
  • インフラ側の人にサーバー構築をお願いしたい人
    • どんなシステムを作るかを一緒になって相談していろいろとツッコミを頂き良いシステムを作りたい人

見てみよう!

百聞は一見にしかず
これがロバストネス図です。
本図は障がい者支援業務の請求業務を題材に、説明の為に架空の業務・システムを取り入れています。
image.png

図の見方

それぞれの要素の説明となります。

要素 説明
image.png システムを利用する人。一般ユーザーや業務システムを使う人。
会社の中にいるカスタマーサポートチームやシステム担当もいる
image.png 外部システム。擬人化しているので人の形となる(お顔に線が入っている)
image.png 画面。情報・操作のインターフェースとするとメーラーもバウンダリになる。
さらにGUIではなくJOBコマンドもCUIの操作インターフェースとしてバウンダリと扱うことにしたがやり過ぎた感がある
image.png   処理。この処理はAPIとして呼び出されるケースもある。
情報インターフェースなのでバウンダリでのいいような気がしたが、API化/処理化は実装しながら変わるかもしれない。ここでは実装工程で変更になり得る粒度にはしたくなかった。
image.png 情報領域。DBのテーブルであったりファイルリソースであったりする。
image.png ユースケース。一般的なロバストネス図でがここに書かない。
業務系においてはその先にある画面を使うシーンをよりイメージしやすくする為に入れてみた。逆に業務系でないシンプルなユースケースの場合は書かなくても良い。これ実は最近RDRAを読んでから取り入れてみたのである。
image.png UML配置図のノードに相当する大きなくくり。一般的なロバストネス図でがここに書かない。
エンジニアってシステム構成図を書きたがらないので、ここで書けば省略できるかもしれないと思い独自ルールとして取り入れて見た
サーバーといった物理的な括りのほか、大きなシステム名(ドメインの括り)も表現できるかもしれない
image.png コンポーネントの括り
Web/API層を括ってみたり、ミドルウェアであったり。
アプリケーション内のパッケージの括りで利用しても良いが、本図ではそこまで細かく定義したことはない
image.png 各種説明。全てを図にするとごちゃごちゃするのでノートで補足説明を行う
image.png 検討中事項。少しでも気になるものは書き留める。
工数見積もりを行う際はこの検討中タスクも忘れずに
やじるし やじるしの向き・実績/波線はあまり厳密に定義していない。気がついたらおおよそ次の法則で書いている
波線=エンティティからデータを取得する場合。向き=なんとなくデータが流れる方向

書くにあたり気をつけているところ

1. 画面からはみ出ないように書く&分割をする

どんな設計図でもこれ重要です。
書いた本人は図の全体を把握しているので理解できるのですが、図が大きすぎると他の人からは理解しづらくなってしまいます。
ユースケースが多い場合は業務を縦で分割すると見やすくなります。
image.png

2. プロダクト立ち上げ時にえいやでざっと全て書く

この設計図は決定事項ではなく、あくまでも協議する為のネタです。
細部まで真剣に書くと時間がかかりますし、協議中に修正されていくので多少雑で良いのです。

3. 細部はコメントでカバー

本来は全ての要素(画面など)を列挙すべきですが、コメントでカバー
仕様が進んできたら、別途詳細な資料を用意するかの検討を行います。
image.png

4. 線のごちゃごちゃは気にする → かぶりは気にしないことにする

共通のAPI、データはあらゆるところから利用されます。
それらに全て線を引くと、ごちゃごちゃして見づらくなるので要素被りの記載はOKとしています。

5. ノード間の繋ぎ目はプロトコル・連携時間を記載

別途配置図(サーバー構成)を書く場合はそちらに書くのですが、問題となり得るのがシステムの境界部分です。
HTTP通信する場合は、外部に公開しても良いものなのか
データ連携を行う場合は、連携手法とその頻度・回数はどの程度か
を書いておくとリスクを早めに協議することができます。
image.png

6. 改修しない要素も全て書く

既存システムの改修・拡張プロダクトにて、初めて本図を作成する場合でも、改修範囲外の全ての要素を書き出すことをお勧めします。
思わぬところへの影響をみつける事ができますし(過去の経験上、いつも発見される)、
本設計図をもとに見積もり表を作成する際には、改修が入らなくても調査するといった隠れ工数を積むことができます。

最後に

世の中には本当にたくさんのモデリング手法が存在しています。
理想理論を細部まで理解し、全てを用意するのは困難を極めます。
そしてそれは、多種多様の立場・スキルを持ったチームで活動する場合において
さらに現実から遠ざかってしまうと感じることがあります。

そんな中、今回ご紹介した「ロバストネス図」は比較的理解・導入しやすい手法であると考えています。

ただし、これは私にとって現実的な手法であり、みなさまはもっと良い方法を見出しているかもしれません。
結局のところ、自分で実務を重ねてアレンジし続けるしか方法はないと思っています。

それでも今回ご紹介したものが、みなさまの手法に改良エッセンスを加えるきっかけになれば
幸いでございます。

13
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
13
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?