Copyright ©2008 IPA
<ガイドラインをご使用になる前にお読みください>
発注者ビューガイドライン(以下、「本ガイドライン」といいます。)を利用することをもって、以下に記載する使用条件(以下、「本使用条件」といいます。)に同意したものとさせていただきます。 本ガイドラインの著作権は、独立行政法人 情報処理推進機構が保有しています。 以下の利用可能な行為を除き、本ガイドラインの一部または全部を著作権法の定める範囲を超え、許可なく改変、公衆送信、販売、出版、翻訳、翻案等をすることは営利、非営利など目的の いかんに関わらず禁じられています。 <本ガイドラインの目的> 本ガイドラインは、外部設計工程における、発注者にわかりやすい仕様の記述方法及び合意方法を世の中に広く普及することを目的としています。 <利用可能な行為> 本ガイドラインは、以下の著作権表示を明記した上で、 著作権表示 : Copyright©2008 IPA 情報システム開発に携わる方が本目的のために ・本ガイドラインの全部または一部を無償で複製すること、 ・本使用条件を配布先に遵守させることを条件に本ガイドラインの複製物を無償で再配布すること、 により利用することができます。 独立行政法人 情報処理推進機構は、本ガイドラインが第三者の著作権、特許権、実用新案権等の知的財産権に抵触しないことを一切保証するものではなく、また、本ガイドラインの内容に 誤りがあった場合でも一切責任を負うものではありません。 独立行政法人 情報処理推進機構は、上記の利用可能な行為を除き、第三者の著作権、特許権、実用新案権等の知的財産権に基づくいかなる権利も許諾するものではありません。 独立行政法人 情報処理推進機構は、本ガイドラインのシステム開発への利用、開発したシステムの使用及びシステムの使用不能により生じるいかなる損害についても、なんら責任を負うも のではありません。 本ガイドラインを海外へ持ち出し、または外国籍の人に提供する場合には、「外国為替及び外国貿易法」の規制及び米国輸出管理規則等外国の輸出関連法規を確認の上、必要な手続きを 行ってください。 本ガイドラインへのお問い合わせについては、独立行政法人 情報処理推進機構 ソフトウェア・エンジニアリング・センターまでご連絡下さい。 JavaおよびすべてのJava関連の商標およびロゴは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。 その他、本書に記載されている会社名、製品名などは各社の商標または登録商標です。 なお、本資料では、™ または® の表記は省略しております。Copyright ©2008 IPA
第1部 - 165
第6章 アクション明細
ここでは「アクション明細」とは何かを定義し、構成要素と表現例について解説す
る。
発注者とのコミュニケーションを促進するための、「アクション明細」の効果的な書
き方のコツを解説する。
発注者とのレビューに備えて「アクション明細」の内容を確認するコツを解説する。
アクション明細
Copyright ©2008 IPA
第1部 - 166
6.1 工程成果物の定義(1/2)
アクション明細では、次の情報を記述範囲とする。
画面単位にボタンを押すなどのそれぞれのイベントに対して発生するアクションの動作を
説明する。
¾
アクションとは、画面遷移に伴って起動される動作
メニューやボタンなど画面上で実行することのできる機能単位
(キーボードでの入力、マウスでの操作、 など)
¾
アクション明細とは、画面遷移に伴って起動させる動作を具体的に説明した工程成果物
z
アクション及び、アクションの処理内容と入出力および条件
z
複数の入力制約に関する動作・イベント
z
ユーザ操作の観点からみた処理の具体的な内容(DB検索、DB登録、絞込み など)
入力制約について単一項目の外部仕様は対象外とする (参考「5.入出力項目」)
アクション明細
Copyright ©2008 IPA
第1部 - 167
検索処理
イベントとアクション
¾
イベント:画面の遷移を引き起こすきっかけとなるもの
¾
アクション:画面遷移に伴って起動される動作
6.1 工程成果物の定義(2/2)
アクション明細
[検索ボタン押下]
例
検索画面 検索結果表示画面検索ボタンを押す
[検索ボタン押下]
イベント発生
検索処理
アクションが開始
検索結果表示
画面に遷移
エラー画面
表示処理
[30秒無応答]
例
検索画面 検索結果表示画面[30秒間無応答]
イベント発生
エラー画面表示
処理が開始
エラー画面に遷移
ERROR: もう一度操作を やり直してください※イベントとアクションは”第2章画面遷移 2.2工程成果物の構成要素” にて定義済
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 168
6.2 工程成果物の構成要素
アクション明細
分類
項
番
記述内容
記述内容の説明
共通情報
-1 画面ID
対象となる画面のID
2 画面の名称
対象となる画面の名称
3 概要
画面の機能の概要を説明する
4 アクション名
アクションを識別する名称
・検索1、検索2、戻る1
・ダウンロード1 など
5 イベント名
画面の遷移を引き起こすきっかけとなるものの名称
・検索ボタン押下
・検索
・○○リンク押下
・30秒間無応答 など
6
アクションの処理
概要
アクションの処理概要をわかりやすい日本語の表現で記述する
7 入力
アクションの処理について入力となる情報を記述する (検索するテーブル名 など)
8
アクションの処理
詳細
アクションの処理の詳細について記述する
以下の内容を盛り込む
①画面の項目の入力値など、条件に応じてアクションが変わる場合の具体的な条件を表
現する
②検索するテーブル
9
遷移先画面名称
(ID)
処理後に遷移する画面の名称
10 出力
アクションの処理によって出力する情報を記述する
プロジェクト名、システム名、工程名、ドキュメントID、ドキュメント名、作者名、作成日付、バージョン、更新者、更
新日付
書誌情報
アクションの構
成要素
Copyright ©2008 IPA
第1部 - 169
6.3 表記例(サンプル)
アクション明細の表記例を示す。
アクション明細
工程
外部設計
作成日付
2007/1/12
更新日付
バージョン
ID
イベント名
入力
遷移先画面名称(I
D)
出力
Username
Password
顧客情報テーブル
-
-ペットストアポータ
ル画面(S-00-01)
顧客情報テーブ
ル
-
-エラーメッセージ
-
-
-言語テーブル
分類テーブル
-ユーザ登録画面
(S-05-02)
--
-エラーメッセージ
「Register
Now!」リンク押
下
ユーザ登録画面を表
示する。
-
-入力されたUsername
とPasswordをもとに顧
客データを検索し、
ユーザ情報画面を表
示する。
ログインボタン
押下
ログイン
②利用環境情報の設定
言語と分類をリスト選択できるようにする
③-1 言語と分類がリストより選択された場
合
ユーザ登録画面を表示する
③-2 リストから選択されなかった場合
エラーメッセージを表示する
ユーザ登録
プロジェクト名
ドキュメントID
A社殿向けJava Pet Store開発
システム名
作成者
佐藤一郎
Java Pet Store
JPS0001
ペット購入システムを利用するために必要なログイン画面
アクションの処理詳細
Java Pet Store外部設計書
更新者
-
-概要
①ユーザ登録画面を初期化する
③-2 合致するデータが存在しなかった場合
エラーメッセージを表示する
①UsernameとPasswordの入力チェック
アクションの処理概要
アクション名
A-05-001
③-1 合致するデータが存在した場合
ペットストアポータル画面に遷移する
②検索処理
顧客情報テーブルから該当するユーザを検
索する
A-05-002
ドキュメント名
画面ID
S-05-01
画面の名称
ユーザログイン画面
【アクションID】(任意)
アクションに対してIDをつけることもよい
(アクション名が長くなる などの場合)
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 170
6.4 設計書記述のポイント
この節では、アクション明細固有の設計書記述やその確認のポイントを記述する。
アクション明細
6.4.1 書き方のコツ
6.4.2 確認のコツ
Copyright ©2008 IPA
第1部 - 171
6.4.1 書き方のコツ
アクション明細の書き方のコツは次のとおり。
アクション明細
ID
内容
FD6001
FD6002
FD6003
条件による場合わけが多い場合やアクションの処理が複雑な場合は「アクションの詳細」欄に
大量に記述が必要になってしまい、確認ポイントがぼやける。
FD6005
あいまいな表現(処理単位,タイミング等)があり処理内容が不明だと、混乱する。設計意図を
正しく伝えられずに誤解を招く。
FD6004
場合わけが発生する場合は階層的に示し、どこで処理が分岐しているのかを明確に示すと、
場合わけの全体像が想起されるため、過不足や問題点の気づきを促すことが出来る。
あるまとまった情報項目群があれば、それらを対象としたアクションの概要を記述する。
アクションの処理概要と処理詳細を分けることにより、何の処理をするのか理解しやすい。
FD6006
実装よりの表現(手続き的な詳細の仕様)となっていると、実際の業務仕様を想起できない。理
解できない。
Copyright ©2008 IPA
第1部 - 172
6.4.1 書き方のコツ
FD6001:「あるまとまった情報項目群があれば、それら対象としたアクションの概
要を記述する」
(“「顧客情報」を登録する”など。「」内があるまとまった情報項目群を示す場合。)
(但し、処
理単位が情報項目群である場合のみ)
アクション明細
ID
アクション名
イベント名
アクションの処理概要
A-001
顧客情報登
録
登 録ボタン 押
下
入 力され た情 報をもとに
「顧客情報」を登録する
ID
アクション名
イベント名
アクションの処理概要
A-001
顧 客 情 報 登
録
登 録 ボ タ ン 押
下
入 力され た情 報をもとに「氏
名」、「郵便番号」、「住所」、
「 電 話 番 号 」 、 「 FAX 番 号 」 、
「メールアドレス」を登録する
望ましくない例
望ましい例
あるまとまった情報項目群で概要を
記述しているためすっきりして見える。
あるまとまった情報項目群があるにもかかわらず、
単項目を列挙して概要を記述しているため、
一見してわかりずらい。
顧客情報
画面レイアウト
登録
書誌情報
新規ユーザ登録
メールアドレス FAX番号 電話番号 住所 郵便番号 氏名①
②
③
④
⑤
⑥
まとまった情報の例
「顧客情報」
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 173
6.4.1 書き方のコツ
FD6002:「アクションの処理概要と処理詳細を分けることにより、何の処理をする
のか理解しやすい。」
わかりやすくするためには、次の点に注意する。
¾
アクションの処理を概要と詳細に分け、ひとまとめにして記述しない
アクション明細
アクションの処理概要
アクションの処理詳細
①顧客情報の入力チェック
②検索処理
入力された情報をもとに顧客情報テーブル
を検索する
③-1 合致するデータが存在しない場合
顧客情報を登録し、顧客登録画面を初期
表示する
③-2 合致するデータが存在した場合
エラーメッセージを表示する
入力された情報をもとに
顧客情報を登録する
入力された顧客情報の入力チェック
を行い、次に入力された情報をもと
に顧客情報テーブルを検索。データ
が存在しない場合には顧客情報を
登録し顧客登録画面を初期表示す
る 。 デ ー タ が 存 在 する 場合に は エ
ラーメッセージを表示する。
アクションの処理概要
概要と詳細に分ける
ことで分かり易くなる
望ましい例
望ましくない例
処理の漏れがないことを確認すること
にも有効。【FD6004参照】
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 174
6.4.1 書き方のコツ
FD6003:「条件による場合分けが多い場合やアクションの処理が複雑な場合は
「アクションの詳細」欄に大量に記述が必要になってしまい、確認ポイントがぼやけ
る。」
わかりやすくするためには、次の点に注意する。
¾
記述内容が大量になる場合は1つの「アクション明細定義」に無理に書かずに「アクション明細
定義」とは別の補足資料に分けて条件や処理を整理すること
アクション明細
アクション明細定義
次へ続く
望ましくない例①
アクション名 アクションの処理詳細 ペットの在庫 管理 ゴールデンレトリバーの注文が1匹で、在 庫が2匹以下なら発注Aをかけ、もっと在庫 があれば出荷と発注Bを行う。また、注文 が2匹で、在庫が2匹以下なら発注Cをかけ、 それ以外なら出荷と発注Bを行う。さらに、 注文が2匹より多くなると性別を指定するこ とが出来、牝を指定して在庫が2匹以下な ら発注Dをかけ、在庫が5匹以下なら出荷 と発注Eをかける。一方で、指定が牡の場 合、在庫が2匹以下なら発注Fをかけ、在 庫が5匹以下なら出荷と発注Gをかける。 なお、性別を問わず、在庫が5匹を超えて いる場合は出荷する。 アクション名 アクションの処理詳細 出力 ①ゴールデンレトリバーの注文数が1匹で、かつ、在庫数が2匹以下の場合 発注A ②ゴールデンレトリバーの注文数が1匹で、かつ、在庫数が2匹を超える場合 出荷・発注B ③ゴールデンレトリバーの注文数が2匹で、かつ、在庫数が2匹以下の場合 発注C ④ゴールデンレトリバーの注文数が2匹で、かつ、在庫数が2匹を超える場合 出荷・発注B ⑤ゴールデンレトリバーの注文数が2匹を超え、かつ、性別指定が牝で、在庫数が2匹以下の場合 発注D ⑥ゴールデンレトリバーの注文数が2匹を超え、かつ、性別指定が牝で、在庫数が5匹以下の場合 出荷・発注E ⑦ゴールデンレトリバーの注文数が2匹を超え、かつ、性別指定が牡で、在庫数が2匹以下の場合 発注F ⑧ゴールデンレトリバーの注文数が2匹を超え、かつ、性別指定が牡で、在庫数が5匹以下の場合 出荷・発注G ⑨ゴールデンレトリバーの注文数が2匹を超え、かつ、在庫数が5匹を超える場合 ペ ッ ト の 在 庫 管理 出荷アクション明細定義
望ましくない例②
記述が大量でポイントがぼやける。
条件分けが整理しきれていなくて、ポイントがぼやける。
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 175
6.4.1 書き方のコツ
注文数
性別指定
在庫数
出力
-
-
-
-
≦ 2匹
発注D
牝
≦ 5匹
出荷・発注E
≦ 2匹
発注F
牡
-
≦ 2匹
> 2匹
≦ 2匹
> 2匹
≦ 5匹
発注C
2匹
出荷・発注B
> 5匹
出荷・発注G
> 2匹
出荷
発注A
1匹
出荷・発注B
①
ゴールデンレトリバーの注文数、性
別指定、在庫数の別に
指示する
(補足資料を参照のこと)
ペ ッ ト の
在 庫 管
理
アクションの処理詳細
アクション
名
発注F
出荷・発注G
出荷
出荷・発注E
発注D
③ゴールデンレトリバーの注文数が2匹を超え、
性別指定が牝である場合で
在庫数が2匹以下
在庫数が5匹以下
性別指定が牡である場合で
在庫数が2匹以下
在庫数が5匹以下
在庫数が5匹を超える場合
出荷・発注B
発注C
②ゴールデンレトリバーの注文数が2匹の場合で、
在庫数が2匹以下の場合
在庫数が2匹を超える場合
出荷・発注B
発注A
①ゴールデンレトリバーの注文数が1匹の場合で、
在庫数が2匹以下の場合
在庫数が2匹を超える場合
ペットの在
庫管理
出力
アクションの処理詳細
ア ク シ ョ ン
名
アクション明細定義
アクション明細定義(補足資料)
アクション明細定義
望ましい例②
望ましい例①
図表(望ましい例①)にしたり、
詳細を分ける(望ましい例②)などの
工夫が必要。
アクション明細
「出力」はアクションの処理によって
出力される情報を明記する。
「アクション」と混同しないように注意。
論理式で表現すると
網羅性の確認もしやすい。
続き
表記例は Java Pet Store* を題材としています。Copyright ©2008 IPA
第1部 - 176
6.4.1 書き方のコツ
FD6004:「場合分けが発生する場合は階層的に示し、どこで処理が分岐している
のかを明確に示すと、場合わけの全体像を想起されるため、過不足や問題点の気
づきを促すことができる。」
わかりやすくするためには、次の点に注意する。
¾
「場合」分けは枝番号をつけて表記する
アクション明細
アクションの処理概要
アクションの処理詳細
①顧客情報の入力チェック
②検索処理
入力された情報をもとに顧客情報テーブル
を検索し
③-1 合致するデータが存在しない場合
顧客情報を登録し、顧客登録画面を初期
表示する
③-2 合致するデータが存在した場合
エラーメッセージを表示する
入力された情報をもとに
顧客情報を登録する
④ 合致するデータが存在した場合
エラーメッセージを表示する
③ 合致するデータが存在しない場合
顧客情報を登録し、顧客登録画面を初期
表示する
②検索処理
入力された情報をもとに顧客情報テーブル
を検索し
①顧客情報の入力チェック
入力された情報をもとに
顧客情報を登録する
アクションの処理詳細
アクションの処理概要
望ましい例
望ましくない例
枝番をつけることで、
場合わけを表現する。
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 177
6.4.1 書き方のコツ
FD6005:「曖昧な表現(処理単位,タイミング等)があり処理内容が不明だと、混
乱する。設計意図を正しく伝えられずに誤解を招く。」
わかりやすくするためには、次の点に注意する。
¾
処理内容、処理の順序、タイミング・条件 などは明確に記述すること
アクション明細
アクションの処理概要
アクションの処理詳細
情報の入力チェック
検索処理
入力された情報をもとに顧客情報テーブルを検索し
合致する顧客情報が存在しない場合
顧客情報を登録し、顧客登録画面を元に戻す
上記以外の場合、エラーメッセージを表示する
例外が発生した場合は元に戻す
入力された情報をもとに
顧客情報を登録する
ユーザ登録画面
(S-05-02)
―
ユーザ登録画面
(S-05-02)
―
―
遷移先画面名称
(ID)
④ 例外が発生した場合は初期表示する
③-2 合致する顧客情報が存在した場合
エラーメッセージを表示する
③-1 合致する顧客情報が存在しない場合
顧客情報を登録し、顧客登録画面を初期表示する
② 検索処理
入力された情報をもとに顧客情報テーブルを検索
し
① 顧客情報の入力チェック
入力された情報をもとに
顧客情報を登録する
アクションの処理詳細
アクションの処理概要
「合致する顧客情報が存在
した場合」と条件・タイミン
グを明記する。
望ましい例
望ましくない例
「元に戻す」は「初期表示する」と
いう具体的な処理内容を明記する。
「チェック」が「顧客情報」の単位
(処理単位)で行うことを明記する。
遷移先を特定するため、
遷移先画面名称を
明記する。
処理の順序を番号をつけて明記する。
(場合分けは【FD6004】を参照)
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 178
6.4.1 書き方のコツ
FD6006:「実装よりの表現(手続き的な詳細の仕様)となっていると、実際の業務
仕様を想起できない。理解できない。」
わかりやすくするためには、次の点に注意する。
¾
表現・用語などはベンダと事前に規定および確認しておくこと
アクション明細
アクションの処理概要
アクションの処理詳細
①入力データの入力チェック
② Search処理
入力されたデータをもとに顧客情報テー
ブルをSearchする
③アンマッチの場合
データをUpdateし、顧客登録画面をクリア
表示する
④Matchするデータが存在した場合
⑤ Exception が 発 生 し た 場 合 は ロ ー ル
バックする
入力されたデータをもと
に 顧 客 情 報 テ ー ブ ル に
Updateする
アクションの処理概要
アクションの処理詳細
①顧客情報の入力チェック
②検索処理
入力された情報をもとに顧客情報テーブルを
検索する
③合致する顧客情報が存在しない場合
顧客情報を登録し、顧客登録画面を初期表
示する
④合致する顧客情報が存在した場合
⑤例外が発生した場合は初期表示する。
入力された情報をもとに
顧客情報を登録する
望ましくない例(実装よりの表現)
望ましい例(業務上の表現)
(ボタンを)押す、選択
クリック
確定、決定
コミット
処理
トランザクション
望ましい例
望ましくない例
上記のほかの表現例
表記例は Java Pet Store* を題材としています。
Copyright ©2008 IPA
第1部 - 179
6.4.2 確認のコツ
アクション明細
ID
内容
FD6007
条件による場合分けが多い場合でも全て記載することで、機能の曖昧な部分を残さず確認で
きる。
FD6008
画面遷移のイベントと名称を統一することで、遷移にまつわるアクションの抜け漏れをチェック
しやすい。
アクション明細の確認のコツは次のとおり。
Copyright ©2008 IPA
第1部 - 180
6.4.2 確認のコツ
FD6007:「条件による場合分けが多い場合でも全て記載することで、機能の曖昧
な部分を残さず確認できる。」
わかりやすくするためには、次の点に注意する。
¾
発生しうるパターンを想定して確認を行うこと
¾
図表にすると漏れに気づきやすくなり、全てを記載することに有効
アクション明細
場合分けが多い場合、補足資料として整理する。
《参考:FD6003》
注文数
性別指定
在庫数
出力
-
-
-
-
≦ 2匹
発注D
0
(未入力)
-
-
エ ラ ー メ ッ
セージ
牝
≦ 5匹
出荷・発注E
≦ 2匹
発注F
牡
-
≦ 2匹
> 2匹
≦ 2匹
> 2匹
≦ 5匹
発注C
2匹
出荷・発注B
出荷・発注G
> 2匹
出荷
> 5匹
発注A
1匹
出荷・発注B
①
ゴールデンレトリバーの注文数、性
別指定、在庫数の別に
指示する
(補足資料を参照のこと)
ペ ッ ト の
在 庫 管
理
アクションの処理詳細
アクション
名
アクション明細定義
アクション明細定義(補足資料)
異常なパターンも発生しうる
ことを想定しておくことが必要。
表記例は Java Pet Store* を題材としています。