設計_基本設計_メッセージ設計書（Excel版）サンプルテンプレート

本記事では、Creative Content Lab Tokyo（クリエイティブコンテンツラボトウキョウ）が作成したメッセージ設計書（エクセル版）版のテンプレートをご提供しております。

チロ

設計工程でシステムやアプリケーションのメッセージを定義する場合にご利用ください。

メッセージ設定書と合わせてコード定義書のテンプレートもご利用ください。

1.テーラリングガイド

１．表紙（メッセージ定義書）

画像はクリックすると拡大表示されます。

表紙については、以下の箇所をプロジェクトに合わせて変更してください。

基本設計工程としていますが、プロジェクトの工程に合わせて適宜変更してご利用ください。

情報種別：社外秘など

情報所有者：基本的にはお客様の会社名となります。

会社名：自社の会社名（正式名称）を記入してください。

タイトル：ドキュメントのタイトルをプロジェクトに合わせて変更

版数、作成日、作成者：※必要に応じて、最終更新日、更新者を入れてください。

２．改訂履歴

版数、変更箇所、変更内容、変更理由、作成日、作成者、更新日、更新者などを記述します。

改訂履歴は、ドキュメントのメンテナンス上必ず設定するようにしましょう。

またプロジェクトごとに記載の粒度やルールを検討してください。

３．メッセージID設定ルール

はじめにメッセージIDの設定ルールについて記載しています。

メッセージIDの構成について本サンプルでは以下のように定義しています。

本プロジェクトで利用するシステムメッセージは、システムID＋機能領域ID＋Sevirity（重要度）＋3桁連番の組み合わせで定義する

メッセージの利用方法については以下のように定義しています。

メッセージIDをプログラムで利用する場合には、事前にカスタム表示ラベルにメッセージIDや定義内容を設置してから利用すること

プロジェクトの開発方針によっては、Apexで利用する場合には、Apexクラス内で固定メッセージを定義して利用する場合もあると思いますが、その場合には、定義しているApexクラスの内容も本設計書に追加するとよいでしょう。

４．メッセージ定義

最初にメッセージIDの設定ルールを定義しましたが、その定義内容に基づきメッセージ定義を作成していきます。

メッセージを利用するシステム、機能領域、種別（Sevirity）によってメッセージIDを定義します。

発生元：メッセージを出力するシステム/機能を定義します。

出力先：メッセージを利用する機能や出力先の画面などを定義します。

Sevirity（重要度）：メッセージの重要度を定義します。

メッセージ：出力するメッセージ内容を定義します。パラメータによってメッセージ内容を置換する場合には、パラメータで置き換える部分を{n}で定義してください。

７．メッセージ利用状況一覧

最後に、メッセージを利用するプログラムとの紐づけを行います。メッセージを変更したり削除した場合にどのプログラムに影響するか把握するためのものとなります。

2.メッセージ設計書（Excel版）のダウンロード

資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。

ダウンロード前に利用規約を必ずお読みください。

一般公開資料

※ダウンロードのリンクをクリックすると自動的にファイルのダウンロードが開始されます。

チロ

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村