第6章　アクション明細

Transcription

1 使用条件 < ガイドラインをご使用になる前にお読みください > 発注者ビューガイドライン ( 以下 本ガイドライン といいます ) を利用することをもって 以下に記載する使用条件 ( 以下 本使用条件 といいます ) に同意したものとさせていただきます 本ガイドラインの著作権は 独立行政法人情報処理推進機構が保有しています 以下の利用可能な行為を除き 本ガイドラインの一部または全部を著作権法の定める範囲を超え 許可なく改変 公衆送信 販売 出版 翻訳 翻案等をすることは営利 非営利など目的のいかんに関わらず禁じられています < 本ガイドラインの目的 > 本ガイドラインは 外部設計工程における 発注者にわかりやすい仕様の記述方法及び合意方法を世の中に広く普及することを目的としています < 利用可能な行為 > 本ガイドラインは 以下の著作権表示を明記した上で 著作権表示 : Copyright 2008 IPA 情報システム開発に携わる方が本目的のために 本ガイドラインの全部または一部を無償で複製すること 本使用条件を配布先に遵守させることを条件に本ガイドラインの複製物を無償で再配布すること により利用することができます 独立行政法人情報処理推進機構は 本ガイドラインが第三者の著作権 特許権 実用新案権等の知的財産権に抵触しないことを一切保証するものではなく また 本ガイドラインの内容に誤りがあった場合でも一切責任を負うものではありません 独立行政法人情報処理推進機構は 上記の利用可能な行為を除き 第三者の著作権 特許権 実用新案権等の知的財産権に基づくいかなる権利も許諾するものではありません 独立行政法人情報処理推進機構は 本ガイドラインのシステム開発への利用 開発したシステムの使用及びシステムの使用不能により生じるいかなる損害についても なんら責任を負うものではありません 本ガイドラインを海外へ持ち出し または外国籍の人に提供する場合には 外国為替及び外国貿易法 の規制及び米国輸出管理規則等外国の輸出関連法規を確認の上 必要な手続きを行ってください 本ガイドラインへのお問い合わせについては 独立行政法人情報処理推進機構ソフトウェア エンジニアリング センターまでご連絡下さい JavaおよびすべてのJava 関連の商標およびロゴは 米国およびその他の国における米国 Sun Microsystems,Inc. の商標または登録商標です その他 本書に記載されている会社名 製品名などは各社の商標または登録商標です なお 本資料では または の表記は省略しております

2 第 6 章 ここでは とは何かを定義し 構成要素と表現例について解説する 発注者とのコミュニケーションを促進するための の効果的な書き方のコツを解説する 発注者とのレビューに備えて の内容を確認するコツを解説する 第 1 部 165

3 6.1 工程成果物の定義 (1/2) では 次の情報を記述範囲とする 画面単位にボタンを押すなどのそれぞれのイベントに対して発生するアクションの動作を説明する アクションとは 画面遷移に伴って起動される動作 メニューやボタンなど画面上で実行することのできる機能単位 ( キーボードでの入力 マウスでの操作 など ) とは 画面遷移に伴って起動させる動作を具体的に説明した工程成果物 アクション及び アクションの処理内容と入出力および条件 複数の入力制約に関する動作 イベント ユーザ操作の観点からみた処理の具体的な内容 (DB 検索 DB 登録 絞込みなど ) 入力制約について単一項目の外部仕様は対象外とする ( 参考 5. 入出力項目 ) 第 1 部 166

4 6.1 工程成果物の定義 (2/2) イベントとアクション イベント : 画面の遷移を引き起こすきっかけとなるもの アクション : 画面遷移に伴って起動される動作 イベントとアクションは 第 2 章画面遷移 2.2 工程成果物の構成要素 にて定義済 例 検索画面 検索結果表示画面 [ 検索ボタン押下 ] 検索処理 検索ボタンを押す [ 検索ボタン押下 ] イベント発生 例 検索画面 [30 秒無応答 ] 検索処理アクションが開始 エラー画面表示処理 検索結果表示画面に遷移 検索結果表示画面 ERROR: もう一度操作をやり直してください [30 秒間無応答 ] イベント発生 エラー画面表示処理が開始 エラー画面に遷移 第 1 部 167

5 6.2 工程成果物の構成要素 分類 項番 共通情報 書誌情報 アクションの構成要素 記述内容 記述内容の説明 1 画面 ID 対象となる画面のID 2 画面の名称 対象となる画面の名称 3 概要 画面の機能の概要を説明する 4 アクション名 5 イベント名 6 アクションの処理概要 アクションを識別する名称 検索 1 検索 2 戻る 1 ダウンロード 1 など 画面の遷移を引き起こすきっかけとなるものの名称 検索ボタン押下 検索 リンク押下 30 秒間無応答など アクションの処理概要をわかりやすい日本語の表現で記述する 7 入力アクションの処理について入力となる情報を記述する ( 検索するテーブル名など ) 8 9 プロジェクト名 システム名 工程名 ドキュメント ID ドキュメント名 作者名 作成日付 バージョン 更新者 更新日付 遷移先画面名称 (ID) アクションの処理の詳細について記述する以下の内容を盛り込む 1 画面の項目の入力値など 条件に応じてアクションが変わる場合の具体的な条件を表現する 2 検索するテーブル 処理後に遷移する画面の名称 10 出力アクションの処理によって出力する情報を記述する 第 1 部 168

6 6.3 表記例 ( サンプル ) の表記例を示す プロジェクト名 A 社殿向けJava Pet Store 開発 システム名 Java Pet Store ドキュメントID JPS0001 作成者 佐藤一郎 ドキュメント名 Java Pet Store 外部設計書 更新者 画面 ID S0501 画面の名称 ユーザログイン画面 概要 ペット購入システムを利用するために必要なログイン画面 A05001 ID アクション名イベント名アクションの処理概要入力 ログイン ログインボタン押下 入力された Username と Password をもとに顧客データを検索し ユーザ情報画面を表示する Username Password 顧客情報テーブル 1Username と Password の入力チェック 2 検索処理顧客情報テーブルから該当するユーザを検索する 31 合致するデータが存在した場合ペットストアポータル画面に遷移する 工程外部設計作成日付 2007/1/12 更新日付バージョン 遷移先画面名称 (I D) ペットストアポータル画面 (S0001) 出力 顧客情報テーブル 32 合致するデータが存在しなかった場合 エラーメッセージを表示する エラーメッセージ A05002 ユーザ登録 Register Now! リンク押下 ユーザ登録画面を表示する 1 ユーザ登録画面を初期化する 言語テーブル 分類テーブル 2 利用環境情報の設定言語と分類をリスト選択できるようにする 31 言語と分類がリストより選択された場合ユーザ登録画面を表示する ユーザ登録画面 (S0502) アクション ID ( 任意 ) アクションに対して ID をつけることもよい ( アクション名が長くなるなどの場合 ) 32 リストから選択されなかった場合 エラーメッセージを表示する エラーメッセージ 第 1 部 169

7 6.4 設計書記述のポイント この節では 固有の設計書記述やその確認のポイントを記述する 書き方のコツ 確認のコツ 第 1 部 170

8 6.4.1 書き方のコツ の書き方のコツは次のとおり ID FD6001 FD6002 FD6003 FD6004 FD6005 FD6006 内容 あるまとまった情報項目群があれば それらを対象としたアクションの概要を記述する アクションの処理概要と処理詳細を分けることにより 何の処理をするのか理解しやすい 条件による場合わけが多い場合やアクションの処理が複雑な場合は アクションの詳細 欄に大量に記述が必要になってしまい 確認ポイントがぼやける 場合わけが発生する場合は階層的に示し どこで処理が分岐しているのかを明確に示すと 場合わけの全体像が想起されるため 過不足や問題点の気づきを促すことが出来る あいまいな表現 ( 処理単位, タイミング等 ) があり処理内容が不明だと 混乱する 設計意図を正しく伝えられずに誤解を招く 実装よりの表現 ( 手続き的な詳細の仕様 ) となっていると 実際の業務仕様を想起できない 理解できない 第 1 部 171

9 6.4.1 書き方のコツ FD6001: あるまとまった情報項目群があれば それら対象としたアクションの概要を記述する ( 顧客情報 を登録する など 内があるまとまった情報項目群を示す場合 )( 但し 処理単位が情報項目群である場合のみ ) 画面レイアウト 書誌情報 氏名 郵便番号 住所 電話番号 FAX 番号 メールアドレス 新規ユーザ登録 望ましくない例 ID アクション名イベント名アクションの処理概要 A001 顧客情報登録 望ましい例 登録ボタン押下 あるまとまった情報項目群があるにもかかわらず 単項目を列挙して概要を記述しているため 一見してわかりずらい 入力された情報をもとに 氏名 郵便番号 住所 電話番号 FAX 番号 メールアドレス を登録する 顧客情報 登録 ID アクション名イベント名アクションの処理概要 A001 顧客情報登録 登録ボタン押下 入力された情報をもとに 顧客情報 を登録する まとまった情報の例 顧客情報 あるまとまった情報項目群で概要を記述しているためすっきりして見える 第 1 部 172

10 6.4.1 書き方のコツ FD6002: アクションの処理概要と処理詳細を分けることにより 何の処理をするのか理解しやすい わかりやすくするためには 次の点に注意する アクションの処理を概要と詳細に分け ひとまとめにして記述しない 望ましくない例 望ましい例 アクションの処理概要 アクションの処理概要 入力された顧客情報の入力チェックを行い 次に入力された情報をもとに顧客情報テーブルを検索 データが存在しない場合には顧客情報を登録し顧客登録画面を初期表示する データが存在する場合にはエラーメッセージを表示する 概要と詳細に分けることで分かり易くなる 入力された情報をもとに顧客情報を登録する 1 顧客情報の入力チェック 2 検索処理 入力された情報をもとに顧客情報テーブルを検索する 31 合致するデータが存在しない場合 顧客情報を登録し 顧客登録画面を初期表示する 32 合致するデータが存在した場合 エラーメッセージを表示する 処理の漏れがないことを確認することにも有効 FD6004 参照 第 1 部 173

11 6.4.1 書き方のコツ FD6003: 条件による場合分けが多い場合やアクションの処理が複雑な場合は アクションの詳細 欄に大量に記述が必要になってしまい 確認ポイントがぼやける わかりやすくするためには 次の点に注意する 記述内容が大量になる場合は 1 つの 定義 に無理に書かずに 定義 とは別の補足資料に分けて条件や処理を整理すること 望ましくない例 1 定義 アクション名 望ましくない例 2 定義 アクション名出力 ペットの在庫管理 ゴールデンレトリバーの注文が 1 匹で 在庫が 2 匹以下なら発注 A をかけ もっと在庫があれば出荷と発注 B を行う また 注文が 2 匹で 在庫が 2 匹以下なら発注 C をかけ それ以外なら出荷と発注 B を行う さらに 注文が 2 匹より多くなると性別を指定することが出来 牝を指定して在庫が 2 匹以下なら発注 D をかけ 在庫が 5 匹以下なら出荷と発注 E をかける 一方で 指定が牡の場合 在庫が 2 匹以下なら発注 F をかけ 在庫が 5 匹以下なら出荷と発注 G をかける なお 性別を問わず 在庫が 5 匹を超えている場合は出荷する ペットの在庫管理 1ゴールデンレトリバーの注文数が1 匹で かつ 在庫数が2 匹以下の場合 2ゴールデンレトリバーの注文数が1 匹で かつ 在庫数が2 匹を超える場合 3ゴールデンレトリバーの注文数が2 匹で かつ 在庫数が2 匹以下の場合 4ゴールデンレトリバーの注文数が2 匹で かつ 在庫数が2 匹を超える場合 5ゴールデンレトリバーの注文数が2 匹を超え かつ 性別指定が牝で 在庫数が2 匹以下の場合 6ゴールデンレトリバーの注文数が2 匹を超え かつ 性別指定が牝で 在庫数が5 匹以下の場合 7ゴールデンレトリバーの注文数が2 匹を超え かつ 性別指定が牡で 在庫数が2 匹以下の場合 発注 A 出荷 発注 B 発注 C 出荷 発注 B 発注 D 出荷 発注 E 発注 F 8 ゴールデンレトリバーの注文数が 2 匹を超え かつ 性別指定が牡で 在庫数が 5 匹以下の場合 出荷 発注 G 9 ゴールデンレトリバーの注文数が 2 匹を超え かつ 在庫数が 5 匹を超える場合 出荷 記述が大量でポイントがぼやける 条件分けが整理しきれていなくて ポイントがぼやける 次へ続く 第 1 部 174

12 6.4.1 書き方のコツ 望ましい例 1 定義 望ましい例 2 定義 出力 はアクションの処理によって出力される情報を明記する アクション と混同しないように注意 アクション名 アクション名 出力 ペットの在庫管理 1 ゴールデンレトリバーの注文数 性別指定 在庫数の別に指示する ( 補足資料を参照のこと ) ペットの在庫管理 1ゴールデンレトリバーの注文数が1 匹の場合で 在庫数が2 匹以下の場合在庫数が2 匹を超える場合 発注 A 出荷 発注 B 定義 ( 補足資料 ) 注文数性別指定在庫数出力 1 匹 2 匹 牝 2 匹 >2 匹 2 匹 >2 匹 2 匹 5 匹 発注 A 出荷 発注 B 発注 C 出荷 発注 B 発注 D 出荷 発注 E 2ゴールデンレトリバーの注文数が2 匹の場合で 在庫数が2 匹以下の場合在庫数が2 匹を超える場合 3ゴールデンレトリバーの注文数が2 匹を超え 性別指定が牝である場合で在庫数が2 匹以下在庫数が5 匹以下性別指定が牡である場合で在庫数が2 匹以下在庫数が5 匹以下在庫数が5 匹を超える場合 発注 C 出荷 発注 B 発注 D 出荷 発注 E 発注 F 出荷 発注 G 出荷 続き >2 匹 牡 2 匹 5 匹 >5 匹 発注 F 出荷 発注 G 出荷 論理式で表現すると網羅性の確認もしやすい 図表 ( 望ましい例 1) にしたり 詳細を分ける ( 望ましい例 2) などの工夫が必要 第 1 部 175

13 6.4.1 書き方のコツ FD6004: 場合分けが発生する場合は階層的に示し どこで処理が分岐しているのかを明確に示すと 場合わけの全体像を想起されるため 過不足や問題点の気づきを促すことができる わかりやすくするためには 次の点に注意する 場合 分けは枝番号をつけて表記する 望ましくない例 望ましい例 アクションの処理概要 アクションの処理概要 入力された情報をもとに顧客情報を登録する 1 顧客情報の入力チェック 2 検索処理 入力された情報をもとに顧客情報テーブルを検索し 入力された情報をもとに顧客情報を登録する 1 顧客情報の入力チェック 2 検索処理 入力された情報をもとに顧客情報テーブルを検索し 3 合致するデータが存在しない場合 顧客情報を登録し 顧客登録画面を初期表示する 31 合致するデータが存在しない場合 顧客情報を登録し 顧客登録画面を初期表示する 4 合致するデータが存在した場合 エラーメッセージを表示する 32 合致するデータが存在した場合 エラーメッセージを表示する 枝番をつけることで 場合わけを表現する 第 1 部 176

14 6.4.1 書き方のコツ FD6005: 曖昧な表現( 処理単位, タイミング等 ) があり処理内容が不明だと 混乱する 設計意図を正しく伝えられずに誤解を招く わかりやすくするためには 次の点に注意する 処理内容 処理の順序 タイミング 条件などは明確に記述すること 処理の順序を番号をつけて明記する ( 場合分けは FD6004 を参照 ) 望ましい例 アクションの処理概要 チェック が 顧客情報 の単位 ( 処理単位 ) で行うことを明記する 遷移先を特定するため 遷移先画面名称を明記する 遷移先画面名称 (ID) 望ましくない例 アクションの処理概要 入力された情報をもとに顧客情報を登録する 情報の入力チェック 検索処理 入力された情報をもとに顧客情報テーブルを検索し 合致する顧客情報が存在しない場合 顧客情報を登録し 顧客登録画面を元に戻す 上記以外の場合 エラーメッセージを表示する 例外が発生した場合は元に戻す 入力された情報をもとに顧客情報を登録する 1 顧客情報の入力チェック 2 検索処理 入力された情報をもとに顧客情報テーブルを検索し 31 合致する顧客情報が存在しない場合 顧客情報を登録し 顧客登録画面を初期表示する 32 合致する顧客情報が存在した場合 エラーメッセージを表示する 4 例外が発生した場合は初期表示する 元に戻す は 初期表示する という具体的な処理内容を明記する ユーザ登録画面 (S0502) ユーザ登録画面 (S0502) 合致する顧客情報が存在した場合 と条件 タイミングを明記する 第 1 部 177

15 6.4.1 書き方のコツ FD6006: 実装よりの表現 ( 手続き的な詳細の仕様 ) となっていると 実際の業務仕様を想起できない 理解できない わかりやすくするためには 次の点に注意する 表現 用語などはベンダと事前に規定および確認しておくこと 望ましくない例 ( 実装よりの表現 ) 望ましい例 ( 業務上の表現 ) アクションの処理概要 アクションの処理概要 入力されたデータをもとに顧客情報テーブルに Update する 1 入力データの入力チェック 2Search 処理 入力されたデータをもとに顧客情報テーブルを Search する 入力された情報をもとに顧客情報を登録する 1 顧客情報の入力チェック 2 検索処理 入力された情報をもとに顧客情報テーブルを検索する 3 アンマッチの場合 3 合致する顧客情報が存在しない場合 データを Update し 顧客登録画面をクリア表示する 顧客情報を登録し 顧客登録画面を初期表示する 4Match するデータが存在した場合 4 合致する顧客情報が存在した場合 5Exception が発生した場合はロールバックする 5 例外が発生した場合は初期表示する 望ましくない例 望ましい例 上記のほかの表現例 トランザクション 処理 コミット 確定 決定 クリック ( ボタンを ) 押す 選択 第 1 部 178

16 6.4.2 確認のコツ の確認のコツは次のとおり ID FD6007 FD6008 内容 条件による場合分けが多い場合でも全て記載することで 機能の曖昧な部分を残さず確認できる 画面遷移のイベントと名称を統一することで 遷移にまつわるアクションの抜け漏れをチェックしやすい 第 1 部 179

17 6.4.2 確認のコツ FD6007: 条件による場合分けが多い場合でも全て記載することで 機能の曖昧な部分を残さず確認できる わかりやすくするためには 次の点に注意する 発生しうるパターンを想定して確認を行うこと 図表にすると漏れに気づきやすくなり 全てを記載することに有効 場合分けが多い場合 補足資料として整理する 参考:FD6003 定義定義 ( 補足資料 ) アクション名 ペットの在庫管理 1 ゴールデンレトリバーの注文数 性別指定 在庫数の別に指示する ( 補足資料を参照のこと ) 注文数性別指定在庫数出力 1 匹 2 匹 2 匹 >2 匹 2 匹 >2 匹 発注 A 出荷 発注 B 発注 C 出荷 発注 B 牝 2 匹 5 匹 発注 D 出荷 発注 E >2 匹 牡 2 匹 発注 F 5 匹 出荷 発注 G 異常なパターンも発生しうることを想定しておくことが必要 0 ( 未入力 ) >5 匹 出荷 エラーメッ セージ 第 1 部 180

18 6.4.2 確認のコツ FD6008: 画面遷移のイベントの名称を対応させることで 遷移にまつわるアクションの抜け漏れをチェックしやすい わかりやすくするためには 次の点に注意する 画面遷移図のアクション イベントとのアクション名 イベント名を対応付けて表 示する 画面遷移図 書誌情報 開始点 初期化初期化 イベント と名称を統一しておくと抜け漏れがチェックしやすい [ 戻る ] ペット検索画面 [ 終了 ] 終了点 処理終了処理終了 ID アクション名 イベント名 アクションの 処理概要 A001 検索処理検索 [ 検索 ] 一致しているか? [ 前ページ ] 検索処理検索処理 ペット検索結果表示画面 前ページ前ページ検索処理検索処理 [ 次ページ ] 後ページ後ページ検索処理検索処理 次を検索 一致しているか? 一致しているか? A002 後ページ検索処理 A003 前ページ検索処理 次ページ 前ページ 前を検索 第 1 部 181

19 コラム 6 アクションとイベントを対応させて記述する 第 1 部 182

20 コラム 6 アクションとイベントを対応させて記述する (1/2) 状況画面遷移と合わせてを記述する場合 関連するコツ FD6008 補足アクションの発生源となるイベントを明確にすることで 抜け漏れなどを発見しやすくなる 第 1 部 183

21 コラム 6 アクションとイベントを対応させて記述する (2/2) 具体例にイベント名とアクション名を合わせて記述する アクションとイベントを区別して並べることで 動作内容とその発生源を明確にしている 項番 アクション名イベント名アクションの処理概要 1 住所検索住所検索ボタン押下 郵便番号に該当する住所を検索し 該当がある場合は住所欄に結果を表示 イベントは通常ユーザの操作等によって発生する 例えば画面の検索ボタンを押す操作を行うと [ 検索ボタン押下 ] というイベントが発生する イベントの発生条件が複雑な場合はイベントの発生する条件とそれによるイベントやアクションの関係を対応する画面レイアウトや画面遷移の補足資料に明記する イベントは人間の操作以外にも ある時間が来ることによって ( 例えば決まった日時など ) 発生するものがある 第 1 部 184