More Related Content
Similar to TAM 新人ディレクター システムスキルアップ プログラム 第5回 「システムドキュメント」
Similar to TAM 新人ディレクター システムスキルアップ プログラム 第5回 「システムドキュメント」 (20)
TAM 新人ディレクター システムスキルアップ プログラム 第5回 「システムドキュメント」
- 2. 第五回:システムドキュメント 12/07/11
今⽇日の内容
› ドキュメントの⽬目的 › 各ドキュメントの⽬目的と例例
› なぜ必要なのか › ⽬目的、記載事項と記載例例
› システム概要図
› ドキュメントの種別 › 機能⼀一覧
› ディレクタ作成のもの › 画⾯面⼀一覧
› 標準ドキュメント › 画⾯面フロー
› 画⾯面設計書
› テスト仕様書
› テーブル設計書
All Rights Reserved. Copyright (C) 2012, T ware 1
- 3. 第五回:システムドキュメント 12/07/11
ドキュメントの⽬目的
› なぜドキュメントが必要か B
› 顧客との意識識合わせのため
› 本来必要な機能が含まれているか どう実現されるか
› ⾒見見積り範囲と費⽤用根拠の確認
› エンジニアとの意識識合わせのため
› ディレクタ、顧客の視線で必要と考える機能の共有
› エンジニアが必要と考える機能も含める
› その他…
› カスタマサポート
› 引き継ぎ 等
All Rights Reserved. Copyright (C) 2012, T ware 2
- 4. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要 B B
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載 W
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 3
- 5. 第五回:システムドキュメント 12/07/11
想定案件
› 会員制サイト
› 対顧客機能
› サイトから会員登録を受付ける
› 会員から何らかの投稿を受付ける
› 会員あるいは⾮非会員からの問合せを受付ける
› 運営側機能
› 会員登録状況を把握したい
› 問合せ対応は、外部に依頼する
› サイト更更新のため、投稿内容を利利⽤用したい
All Rights Reserved. Copyright (C) 2012, T ware 4
- 6. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 5
- 7. 第五回:システムドキュメント 12/07/11
システム概要図 B
› ⽬目的
› 実現するシステムの全体像を顧客と確認する
› 機能のモレを防⽌止
› 他システムや関連部署もチェック
› 記載内容
› コミュニケーションを容易易にするためブロック図で表現
› 具体的なイメージ(絵)等を使⽤用した⽅方が良良い
› サーバを中⼼心として、関連部署、関連システムを記載
› 開発が必要と思われる機能の名前を記載
› 必要に応じて、連絡経路路、モノの流流れ等も記載
All Rights Reserved. Copyright (C) 2012, T ware 6
- 8. 第五回:システムドキュメント 12/07/11
システム概要図(例例) B
会員サイト
記事データの更更新 CMS
記事⽣生成
パッケージ
⾃自動
更更新
会員⼀一覧 会員登録
投稿受付 データ 投稿
サイト管理理者 ベース
エンド
会員参照 ユーザ
問合せ
編集
サポート報告 ⾃自動メール通知
及びサイト参照
問合せ 会員登録
受付 編集
⾃自動メール通知
及びサイト参照
カスタマ
サポート メールまたは
電話による回答
All Rights Reserved. Copyright (C) 2012, T ware 7
- 9. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 8
- 10. 第五回:システムドキュメント 12/07/11
機能⼀一覧 B
› ⽬目的
› 開発対象の機能を明確にする
› 機能毎の⾒見見積りを顧客に分かりやすく提⽰示する
› 開発対象から外す等の判断をしやすくする
› 記載事項
› 開発対象(または候補)の機能を⼀一覧表形式で表現
› ⼀一覧表の項⽬目(例例)
› 公開機能と管理理系機能の種別
› 機能名称
› 機能の概要
› 機能開発のための⼯工数
All Rights Reserved. Copyright (C) 2012, T ware 9
- 11. 第五回:システムドキュメント 12/07/11
機能⼀一覧(例例)B
No. 名 称 概 要 ⼯工数(⼈人⽇日)
CMSパッケージを利利⽤用して記事を⽣生成
1 記事⽣生成 2.0
(テンプレート作成が必要)
公 エンドユーザからの会員登録を受付け、個⼈人情報を
2 会員登録 3.0
開 DBに格納する
機
3 能 投稿 会員からの投稿を受付け、DBに格納する 2.0
4 問合せ エンドユーザからの問合せをDBに格納する 2.0
5 会員登録/編集 DB内の会員データの編集削除を受付ける 3.0
登録済み会員の総数と共にDBに登録された内容を
6 会員⼀一覧 5.0
⼀一覧表⽰示(会員検索索可能)
会員から受付けた投稿をテキストファイルでエクス
7 投稿受付 2.0
管 ポートする
理理 会員から受付けた投稿データをCMSパッケージに
8 者 記事⾃自動更更新 5.0
機 ⾃自動送信する(1⽇日1回バッチ処理理)
能 登録済み会員情報の詳細を表⽰示し、登録内容の編集
9 会員参照/編集 4.0
を⾏行行う
受付けた問合せデータを⼀一覧表⽰示し、個別の詳細表
10 問合せ受付 4.0
⽰示を⾏行行う
All Rights Reserved. Copyright (C) 2012, T ware 10
- 12. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 11
- 13. 第五回:システムドキュメント 12/07/11
画⾯面⼀一覧 B
› ⽬目的
› 機能の実現⽅方法のイメージを顧客と共有する
› 画⾯面数から、全体の規模を確認する
› 記載事項
› 機能毎に必要な画⾯面をブロック図で表現
› 機能と画⾯面名を関連付けて把握できるように記載
All Rights Reserved. Copyright (C) 2012, T ware 12
- 14. 第五回:システムドキュメント 12/07/11
画⾯面⼀一覧(例例) B
■管理理系機能
管理理者 管理理者
会員⼀一覧 会員検索索
ログイン メニュー
会員情報 会員情報
編集 ⼊入⼒力力確認
投稿データ
投稿⼀一覧
ダウンロード
問合せ
問合せ⼀一覧
詳細表⽰示
All Rights Reserved. Copyright (C) 2012, T ware 13
- 15. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 14
- 16. 第五回:システムドキュメント 12/07/11
画⾯面フロー B
› ⽬目的
› 画⾯面の流流れを明確にする
› 操作性や画⾯面移動の⼀一貫性を確認する
› 記載事項
› 画⾯面の流流れをブロック図で表現
› 操作による画⾯面移動を⽮矢印で記載
› 移動のきっかけになる操作(ボタンのクリック等)も記載する
All Rights Reserved. Copyright (C) 2012, T ware 15
- 17. 第五回:システムドキュメント 12/07/11
画⾯面フロー(例例) B
管理理者 ログイン 管理理者 会員管理理 検索索
会員⼀一覧 会員検索索
ログイン メニュー
会員名 会員名
リンク リンク
会員情報 確認 会員情報
編集 ⼊入⼒力力確認
登録
All Rights Reserved. Copyright (C) 2012, T ware 16
- 18. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 17
- 19. 第五回:システムドキュメント 12/07/11
画⾯面設計書 B
› ⽬目的
› 機能の詳細を画⾯面単位に明確にする
› 表⽰示処理理、各ボタンクリック時の処理理等
› ⼊入⼒力力データを明確にし、エラー検出条件を明確にする
› テスト仕様書のベース
› 記載事項
› 画⾯面イメージに近い形で、表⽰示要素、データ⼊入⼒力力要素等を記載
› 処理理内容を記載
› 表⽰示処理理
› ボタン類をクリックした場合の処理理
› エラー判定処理理
All Rights Reserved. Copyright (C) 2012, T ware 18
- 20. 第五回:システムドキュメント 12/07/11
画⾯面設計書(例例) B
デザイン的要素は
必須ではない
All Rights Reserved. Copyright (C) 2012, T ware 19
- 21. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 20
- 22. 第五回:システムドキュメント 12/07/11
テスト仕様書 B
› ⽬目的
› 動作確認のためのテスト項⽬目を明確にする
› 同レベルのテスト実施をいつでもできるようにする
› テスト結果を記録し、テストが完了了している範囲を明確にする
› 記載事項
› 画⾯面設計書に基づき、テスト項⽬目と実施結果を記載
› 以下の項⽬目を記載
› テスト項⽬目
› 予測結果
› 実施結果
All Rights Reserved. Copyright (C) 2012, T ware 21
- 23. 第五回:システムドキュメント 12/07/11
テスト仕様書(例例) B
No. テスト項⽬目 予測結果 結果 備 考
ログインIDが空欄でログインボタンを
1 、エラー<ER001>となる ○
クリック
ログインIDが16⽂文字以内の半⾓角英数⽂文
2 字でない場合に、ログインボタンをク エラー<ER002>となる ○
リック
パスワードが空欄でログインボタンを 認証不不⼀一致と
3 エラー<ER003>となる ×
クリック なる
パスワードが16⽂文字以内の半⾓角英数⽂文
4 字でない場合に、ログインボタンをク 、エラー<ER004>となる ○
リック
DBに登録されていないログインIDを
5 エラー<ER005>となる ○
⼊入⼒力力してログインボタンをクリック
ログインIDに対する登録済みパスワー
6 エラー<ER006>となる ○
ドが⼊入⼒力力データと⼀一致しない場合
All Rights Reserved. Copyright (C) 2012, T ware 22
- 24. 第五回:システムドキュメント 12/07/11
ドキュメント種別
No. 名 称 概 要
デ
1 システム概要図 開発機能と関連する⼈人、システムを記載
レ
2 機能⼀一覧 実装する機能の⼀一覧で⾒見見積りにも使⽤用 ク
タ
作 標
3 画⾯面⼀一覧 画⾯面の構成を記載(機能と画⾯面数) 成 準
ド
キ
4 画⾯面フロー 画⾯面の流流れを記載(機能の動き)
メ
5 画⾯面設計書 各画⾯面の構成要素と動きを記載 ン
ト
6 テスト仕様書 画⾯面毎に⼊入⼒力力と動作、テスト結果を記載
7 テーブル定義書 データベースのテーブル定義を記載
8 詳細設計書 プログラム内部処理理の詳細を記載
有
償
9 運⽤用設計書 保守作業、エラー時の⼿手順等を記載 対
応
10 操作マニュアル 機能の操作⼿手順を記載
All Rights Reserved. Copyright (C) 2012, T ware 23
- 25. 第五回:システムドキュメント 12/07/11
テーブル設計書
› ⽬目的 B
› データベースの基本的な設計資料料として開発に使⽤用
› 引き継ぎ資料料としても有⽤用
› 記載事項 W
› データベースのテーブル設計情報を表形式で表現
› テーブル⼀一覧
› データベースに含まれるテーブルのリスト
› テーブル定義
› フィールド名、型、データ⻑⾧長、値の意味 等
All Rights Reserved. Copyright (C) 2012, T ware 24
- 26. 第五回:システムドキュメント 12/07/11
テーブル設計書(例例) W
■テーブル⼀一覧
No. テーブル名 概 要 備 考
1 admin_users 管理理ユーザリスト
2 email_list メールマガジン登録者データ
3 contribution 投稿データ
■テーブル定義
No. フィールド名 型 Length NOT NULL 値 内容
1 id integer NOT_NULL ID
2 login_name varchar 16 NOT_NULL ログインID
3 password varchar 16 NOT_NULL パスワード
4 isValid integer 1 NOT_NULL 1:有効、2:無効 ログイン可能状態
All Rights Reserved. Copyright (C) 2012, T ware 25
- 27. 第五回:システムドキュメント 12/07/11
これだけは憶えよう
› ドキュメントの⽬目的 › 機能⼀一覧
› 顧客、エンジニアとの意識識 › 開発対象を明確にし、⾒見見積り
合わせ にも利利⽤用
› ドキュメント種別 › 画⾯面⼀一覧
› ディレクタ作成 › 画⾯面数と構成から規模を確認
› システム概要図、機能⼀一
覧、画⾯面⼀一覧 › 標準ドキュメント
› 上記3種に加え、画⾯面フロー、
› システム概要図 画⾯面設計書、テスト仕様書、
› 全体像を顧客と確認 テーブル設計書
All Rights Reserved. Copyright (C) 2012, T ware 26
- 28. 第五回:システムドキュメント 12/07/11
ご質問、お問合せお寄せ下さい
toru@tam-‐tam.co.jp
support@i-‐tware.com
All
Rights
Reserved.
Copyright
(C)
2012,
T ware 27