⚙️

プログラム設計書に書くべき内容

2025/03/09に公開

はじめに

下記の5ページを用意します。

  1. 表紙
  2. 仕様書
  3. 編集出力
  4. 入力
  5. 出力

 

表紙

  • システム名
  • プログラム名
  • 作成日
  • 作成者

 

仕様書

冒頭

表紙と同項目の内容を書きます。

処理フロー

図を用いて処理フローを書きます。
【手順】

  1. 入力⇒取り込まれるプログラム⇒出力の流れを添付する。
  2. 関連するDBやファイルがあれば添付する。

プログラム構造部

下記の流れを文章で書きます。

  1. 初期処理
  2. 開始処理
  3. 入力処理
  4. 条件判定処理
  5. 編集処理
  6. 出力処理
  7. 終了処理

 

編集出力

出力レイアウトの中から動的な部分にどんな値が入るか書きます。
※ユーザー操作画面を想定
※可変値を書き出す

No. 項目名 I/O 桁数 入出力方法 表示データ元 表示データ元詳細 エラーチェック 設定値
1 日付 O Date PHP PHPオブジェクト Date関数 なし 入力と同項目を設定
2 言語 O 整数 1 クエリ取得 DB languageカラム 整数・小数点チェック 0⇒日本語 1⇒英語 を設定
3 氏名 I 文字列 ユーザー入力 必須チェック 入力と同項目を設定

 

入力

プログラムに入る入力ファイルのレイアウトを添付します。

 

出力

プログラムから出る出力ファイルのレイアウトを添付します。

Discussion