システム設計書作成課題

内容 プロクターから提示された要求仕様書をもとに、外部設計書を作成し、プロクターの承認を得ること。外部作成書の承認を得たら、内部設計書を作成し、プロクターの承認後に、開発に着手する。プログラム中の必要な箇所は、コメントをつけるように気をつけること。開発後には、システムテストを計画・実施し、その結果を報告書としてまとめること。ソースコード、テスト報告書ともプロクターの承認を得ること。
なお、各書類の書式等については特に指定はしないが、先輩のを参考にして作成すること。

1. 要求仕様書に関する内容(プロクターが作成)

要求仕様書には、
(ア) システム機能の概要
(イ) システム性能の目標
(ウ) データおよびライフサイクルの概要
(エ) ネットワーク、ハードウェア、ソフトウェア構成
について、説明されていることが一般的である。

※要求仕様書が示された時に、分からない部分は、プロクター(クライアント)と相談すること。
 要求仕様書を満たすシステムを開発することが求められるので、この段階でできるだけ明確にしておくこと。

2. 外部設計書

ユーザ向けのドキュメントである。要求仕様書をもとに、このシステムで何ができるかをまとめる。外部設計書を見れば、どんな機能を持ったシステムになるのか、わかるように概要を記述すること。

(ア) 作成時に、以下の3点を意識する

(イ) 外部設計書の中には、以下の内容を記載すること(必須・順不同)

これ以外に、必要だと思われていることは、追加しても構わない。

  1. 開発期間・終了日
  2. 開発者
  3. システムが使用されるときのシナリオ(どんな時にこのシステムが有効であるかの例)
  4. 機能の内容(できれば、画面図などを用いる)
  5. 機能に含まれていないもの/注意書き/未解決の問題
  6. その他説明が必要と思われる詳細事項に関して

3. 内部設計書

開発者向けのドキュメントである。外部設計で示した内容がどのように実現されているのか、具体的に示す。プログラムの中身について具体的に記すこと。内部設計書には、以下のものが含まれているようにする。

(ア) システム全体のアーキテクチャの図と簡単な解説

(クライアントとサーバの構成図、DBなどを利用した場合はその連携図など) (必須)

(イ) 作成するプログラム情報

  1. プログラム・データファイル構成(ファイル名とその内容)
  2. プログラムファイル内にあるユーザ定義関数名とその機能、入出力
  3. 関数のやりとりがわかる概念図-ユーザから受け取ったデータをどのように処理されているかプロセスの全体像がわかるように(形式は自由)

4.ソースコード

どのような処理が書かれているか、作成者以外にも共有できるように、コメント行を用いてわかりやすく説明されていること

プログラムが長い場合は、大きな機能ごとに説明をつけることが望ましい

5.システムテスト報告書

今まで作成した設計書に基づいて、画面上にある入力領域に、正常に動作するデータ(正常系)・エラーとなるべきデータ(異常系)を入力し、どのような結果になるかそれぞれテストし、結果をまとめる。この際に以下の点に注意する。


鈴木研究室 2005