0.外部設計書,内部設計書の違いと記載事項の読み方-はじめに
現場にもよるが、新人として企業に入ってアプリケーション作成に携わると以下の指示される可能性がある。
「設計書や仕様書の勉強をしておいて(^^)」
何とかなるだろうと思ってとりあえず見てみると、
- ・量が多い……
- ・全体の構成が頭に入ってこない……
- ・何を中心に読めばいいのかが分からない……
というような感じで勉強しようにも勉強出来ないというような形に私が新人の頃陥ったので、同じ問題を抱えている方のために今の私の設計書、仕様書についての概要と読むべき点について共有しておく。
1.設計書の概要
設計書は作成段階ごとに大きく以下の3つに分かれている。
1-1.要件定義書
……作成するアプリケーションに必要な機能をまとめたもの。
要件定義とは、作成するアプリケーションに必要な機能や性能に関してお客さんと相談して決めることである。
基本設計書との違いが少しややこしいが相談して決めた必要な機能について記載したものが要件定義書、それを受けてどのようなシステムにするかを落とし込んだのが基本設計書である。
1-2.基本設計書(外部設計書)
……作成するアプリケーションの概要をまとめたもの
基本設計書はアプリケーションの大枠について記載されたものである。
作成するアプリケーションは何をするためのものなのか、大雑把にはどんな仕組みになっているのかを示したものであり、詳細設計書と比べると読んで分かりやすいことが重要視されている。
外部の利用者視点でのアプリケーションの構造やどんな動き方をするのかを示したものであることから、外部設計書と呼ばれることもある。
1-3.詳細設計書
……プログラムを文章化したもの
詳細設計書は名前の通り、具体的にプログラムでどーなロジックを作成するかを記載したものであり、詳細設計書を見れば誰でも(というかコ－ディングの段階から入ってきた人でも)
その通りにプログラムをプログラムを組めるようになっているのが理想とされている。
具体的には以下のことが書かれていることが多い。
- ・プログラムでやっていること
- ・プログラムで使用しているデ－タ
- ・参照している他のプログラムファイル
また、詳細設計書は情報処理技術者試験では内部設計書と呼ばれることもあるが、これはプログラムを作成する段階で内部の人がよく参照することが多いことから内部設計書と呼ばれている。
本ページの説明では、プログラム設計書を知らない人読む準備ができるようになることを目的としているため以上の設計書の概要のみにとどめる。なお、さらに設計書の内容を詳しく知りたい方は以下のサイトを参照すると良い。
2.設計書はどこまで覚えればいいのか?
当然、設計書を読んだだけで一字一句全て覚えるということは不可能である。
私は以下のものがどこに書いてあるのかをすぐに調べられる状態になっていればいいものと思っている。
- ・プロジェクト特有の用語
- ・マスタデ－タのコ－ド
- ・運用上よく利用される電文の構造
- ・よく使用されるデ－タべ－スのテ－ブル名とその機能
- ・よく使用されるプログラムファイルが持っている機能
※異常時にのみ使用されるテ－ブルやプログラムファイルについては最初の勉強の段階では覚える必要はない。
3.基本設計書を読むに当たって知っておくと楽になるもの
○帳票
……伝票や明細書、領収書のような会計や税金関係で用いる書類を発行する機能
○バッチ
……背景が真っ黒で文字を打つ画面(コマンドプロンプトやタ－ミナルなど)を用いて一度に複数の命令文章化を実行する効率化ツ－ルのこと
○インターフェ－ス仕様書
……「インターフェース」という言葉はオブジェクト指向という見やすいプログラムを作成するために使われる概念である。
具体的な中身について説明するとインターフェースは「型」や「構造」のようなものと考えるとイメージしやすい。インターフェースは単体では機能せず、インターフェースに沿って中身を入れることで初めて使えるようになるものである。
設計書としては構造を示すものとして書かれることが多く、マスタデ－タの中身や他の機器に送る電文に関しても構造が書かれている。