前回、弊社のEC事業部の基本設計書をご紹介したところ、
好評だったため、今回はERPチームの基本設計書をご紹介したいと思います。
これが正解というわけではありませんが、他社の設計書を見る機会はあまりないと思いますので、是非参考にしてみて下さい。（データ部分は必要に応じ削除しております。ご了承下さい。）
設計構成
下記は販売-売上機能の基本設計の構成になります。
- 設計書（表紙）
- 変更履歴
- 機能概要
- 機能関連図
- 画面レイアウト
- 仕様詳細
- ファンクションキー
- メッセージ一覧
- 補足
- レビューメモ
続いて、詳細を見ていきたいと思います。
①設計書（表紙）
下記が基本設計の表紙になります。
- ID
- 機能名
- 対象モジュール
- パッケージ名
- 作成者
どの企業向けのシステムや、対象となるモジュールなどは基幹業務ならではの項目と言えるかもしれません。
②変更履歴
変更履歴の項目は以下になります。
- 日付
- 更新者
- 変更概要
変更履歴に関してはどの企業でも記載されてるかと思いますが、上記3点が最低でも必要になる項目と言えるでしょう。
③機能概要
機能概要は要件定義にてヒヤリングした内容をもとに、対応方針や、前提条件を記載します。
意外に、重要なのは前提条件です。ここの記載を疎かにしてしまうとどのようなケースでも要件が満たされると勘違いを生む原因となるので注意しましょう。
④機能関連図
機能関連図では凡例にある通り、下記を表現します。
- テーブル
- ビュー
- 画面
- 処理
- 出力
- 参照
- CSVファイル
- 帳票
設計書に限らず、言葉ばかりの設計書だとイメージが付きづらい部分があります。
また、基本設計書はエンドユーザもしっかり確認することが多いので、重要な設計書の一つと言えるでしょう。
⑤画面レイアウト
画面レイアウトは皆さんのイメージ通りかと思いますが、状況に応じて画面レイアウトが変更される場合もしっかりと表現するようにしています。
今回の例だと、カスタマイズ時のレイアウトも記載するようにしています。
⑥仕様詳細
今回の例では仕様詳細という名前ですが、会社によっては項目定義などと呼ばれるケースもあるかもしれません。実際に記載している内容は同一かと思われますので参考にしてみて下さい。
- 項番
- 項目名
- 型/種別
- IME
- 最大桁数
- 必須
- 初期値
- 参照
- I/O
- 取得元
- 備考
⑦ファンクションキー
弊社が提供するシステムはファンクションキーが有効なので、それぞれのキーに応じた動作イベントを記載しています。
⑧メッセージ一覧
メッセージ一覧はどのような設計書でも記載されているかと思います。
今回の例では表示メッセージと備考を記載するフォーマットとなっていますが、 必要に応じてどのような状況でメッセージが表示されるかなどを記載しても良いでしょう。
⑨補足
補足説明では①～⑧で記載できない部分を補います。
インデントだけしっかり決めて、必要なものを記載しましょう。
⑩レビューメモ
レビューメモは社内、パートナーなど指摘者を記載し、対応者を記載しましょう。
- レビュー日付/指摘者
- 対応日付/対応者
- 指摘事項
- 確認結果
- ステータス
- 課題番号
必要に応じて課題もでてくるかと思いますが、設計書とは別に課題管理表を用意して管理しましょう。
今回は弊社のERP事業にて活用された設計書フォーマットをご紹介しました。
あまり、他社の設計書を見る機会は無いと思いますが、貴社の設計品質を上げるためのお役に立てれば幸いです。
Object Browser 事業部
