WEBシステム開発｜PHPとPostgreSQLの開発例｜●2_03_06-定義書の出力、編

●2_03_06-定義書の出力、編集

データベースに関するドキュメントとして定義書の出力、編集を説明します。
今は入門用の説明でテーブルは1つですが実際の開発では目安としてですが小規模でも10から40ぐらい、中規模でも100程度、大型のシステムとなると数百のテーブルまで達します。

これをいちいちデータベースに接続して確認していては全体を見通すのにロスが出ます。そのため定義書でテーブルの詳細を記載してシステムのデータベースの内容を明らかにします。

テーブルの定義書だけでは不足で、各テーブル間の関係を表す図(ER図と呼ばれたりします)も必要になります。これに関してはもう少し演習で複数のテーブルの関係を説明するところで記載するつもりです。


CSEでデータベースの「kaden_hanbai」に接続して、「new_jouhou_t」テーブルを右クリックしてメニューを出して下さい。
下記のメニューを選択して下さい。


下記のウインドウが出ますので「保存」をクリックします。エクセルで保存されます。
これを開くには前もってエクセルがインストールされている必要があります。


完了のメッセージが出ますので「OK」をクリックします。


保存したファイルを開きます。


前もって取得している情報は書き込まれています。
残っている項目に記載を追加します。

「システム名」は「家電販売システム」としました。



「作成者」は本人、「承認者」は「田中一郎」としてみました。
テーブルの内容を変更した時は「最終更新日」を変更して記載します。


テーブルの説明を分かり易く「概要」に記載します。



各カラムを分かり易く「備考」に追加します。



「コメント」に補足的な説明を追加しました。



以上は例ですので別に正解という訳ではありません。データベースのテーブルの内容をできるだけ誰でも（もちろんスキルは必要ですが）がすぐ分かるような記載が理想的です。

今回は1個のテーブルしかありませんが複数のテーブルを一度に定義書に出力する場合は下記のメニューを選択します。「new_jouhou_t」テーブルではなく上の階層の「テーブル」を選択します。



「new_jouhou_t」以外はシステムが使用するテーブルですので通常は選択する必要はありません。
「OK」ボタンの上に記載している方法で出力したいテーブルを選択して「OK」をクリックすると定義書が出力されます。





戻る