本記事では、Creative Content Lab Tokyo(クリエイティブコンテンツラボトウキョウ)が作成したコード設計書/コード定義書(エクセル版)のテンプレートをご提供しております。
1.テーラリングガイド
1.表紙(メッセージ定義書)
画像はクリックすると拡大表示されます。
表紙については、以下の箇所をプロジェクトに合わせて変更してください。
基本設計工程としていますが、プロジェクトの工程に合わせて適宜変更してご利用ください。
情報種別:社外秘など
情報所有者:基本的にはお客様の会社名となります。
会社名:自社の会社名(正式名称)を記入してください。
タイトル:ドキュメントのタイトルをプロジェクトに合わせて変更
版数、作成日、作成者:※必要に応じて、最終更新日、更新者を入れてください。
2.改訂履歴
版数、変更箇所、変更内容、変更理由、作成日、作成者、更新日、更新者などを記述します。
改訂履歴は、ドキュメントのメンテナンス上必ず設定するようにしましょう。
またプロジェクトごとに記載の粒度やルールを検討してください。
3.コード体系一覧
コード設計では、まずシステムで利用するコードの体系を整理します。コードは細かく分類すると複数の種類がありますが、ここではシンプルに2種類で分類しています。
主にプログラム等で自動採番する可変のコード値と、選択リストなどで定義する固定のコード値に分類しています。
コード定義する項目名とコード体系(コードを構成する要素の組み合わせ)を定義して、桁数や構成内容の細かい定義を説明しています。
【記載内容】
- 項目名:コード体系として定義する項目名(論理名)を定義します。
- コード体系:コードを構成する要素の組み合わせを定義します。
- 設定方式:自動採番か固定値かを定義します。
- 桁数:コードの最大桁数を定義します。
- 説明:コードの採番方式や構成要素に関する説明を記入します。
- 設定例:実際に定義されるコード値の設定例を記入します。
- 補足:コードに関する補足事項を記入します。
4.コード値定義
続いてのシートでは、具体的なコード値を定義していきます。コード値と説明(プログラムの制御やコードの意味を定義します。
【記載内容】
-
- 項目名:コード名(論理名)を記入します。
- 物理名(API参照名):コードを選択リストなどで定義する場合のAPI参照名を記入します。
- 設定場所:コード値を定義する場所を記入します。選択リストや選択リスト値セット(グローバル選択リスト)、プログラム内に固定など
- コード値:コード体系で定義されているコード値を記入します。※ひとつのコード体系について複数の値がある場合は行を分けて記入します。
- 説明(処理制御):コード値のそれぞれの意味や処理制御で利用する場合の制御内容などを記入します。
4.コード利用状況一覧
コード体系とコード値の定義が完了したら最後にコード利用状況一覧を作成します
こちらでは、コードを利用する各機能/プログラムとの紐づけをマトリクス表に整理します。これを作成することにより、コード値を変更した場合にどの機能/プログラムに影響するか簡単に確認することができるようになります。(影響範囲の調査用)
- 機能ID:システム機能IDを記入します。
- 機能種別:機能の種類(画面、帳票、バッチ、APIなど)
- 機能名:システム機能名を記入します。
- プログラムID:プログラムIDを記入します。
- プログラム名:具体的なプログラム名(API参照名)を記入します。
- コード名:縦軸にはコード名を定義して、対象のコードが利用される機能に対して●をつけていきます。
2.コード設計書/コード定義書の(Excel版)のダウンロード
資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。
一般公開資料
設計_基本設計_コード設計書/コード定義書(EXCEL版)のダウンロード
※クリックして資料のダウンロードが開始されるまで少し時間がかかる場合がありますので、そのままお待ちください。
もしダウンロードが開始されない場合、ブラウザでポップアップブロックされている可能性があるのでご確認ください。
まとめ
そのほか設計・開発に関するドキュメントをお探しの場合は、以下の記事にご利用可能な全てのコンテンツ(ドキュメント)が掲載されているので、合わせてご利用ください。
-
参考ダウンロード可能なコンテンツ(サンプル・フォーマット)一覧
チロお問合せ・ご要望いただいているコンテンツも頑張って作成しているので、もうしばらくお待ちください ダウンロード可能なコンテンツ一覧 提供しているテンプレートと公開範囲は以下の通りとなっています。 ★ ...
続きを見る