はじめに

こんにちは。株式会社SHIFT Salesforceグループの小笠原です。
今回は、Salesforceの導入に必要な詳細設計書と、質の高い設計書がもたらすメリットの二本立てで記事にしました。
「Salesforceの詳細設計書ってどんなものが必要なの？」「そもそも詳細設計書ってなんだっけ？」「設計書は大事ってよく聞くけど、なんで大事なの？」といった疑問をお持ちの方の参考になればと思い執筆しました。
ぜひご一読ください！

システム開発における各種ドキュメント

詳細設計書の説明の前に、システム開発における各種ドキュメントについて触れさせていただきます。
Salesforceの導入に限らず、システム開発にはたくさんの設計書が必要になります。高品質なシステムを作るためには、質の高い設計書の作成が不可欠です。
システム開発におけるドキュメントには、大きく分けて要件定義書、基本設計書、詳細設計書の3種類があります。 それぞれの詳細の役割についてはここでは割愛しますが、要件定義書は顧客がシステムに求める機能や仕様の概要をまとめたもの、基本設計書は要件定義で定めた機能や仕様を明確にしたものと、大まかに理解しておきましょう。
今回はこの中の詳細設計書に焦点を絞って、Salesforceの導入に必要な設計書について解説していきます。

詳細設計書とは

詳細設計書とは、基本設計書をさらに詳細化したものです。各機能の仕様、動作、見た目、設定値が詳細に記載されています。実装者はこれをインプットにして製造工程を進めていきます。
記載内容の粒度については、仮に実装者がシステムの仕様に詳しくない場合でも問題なく実装作業が進められるくらい詳しく書かれていることが理想的です。

Salesforceの詳細設計書

詳細設計書はシステムの各機能ごとに作成するため、Salesforceの機能や仕様に合わせた設計書が必要になります。そのため、Salesforceの導入には、他のシステム開発では聞き慣れない名前の設計書がたくさんあります。今回は、Salesforceの導入に必要な詳細設計書の一例を紹介していきます。

オブジェクト定義書

オブジェクトの設定値を定義した設計書です。オブジェクトに関連する設定は数が多いため、最もボリュームの大きい詳細設計書の一つです。主な記載内容は以下のとおりです。

• 項目一覧

• ボタン、リンク、およびアクション一覧

• レコードタイプ

• リストビュー

• 検索レイアウト

• 入力規則

レイアウト定義書

レコードページのレイアウトを定義した設計書です。 レイアウト図の他に、画面に表示する項目やコンポーネントの表示条件等について記載します。

権限定義書

プロファイル、ロール階層、権限セット、共有設定など、オブジェクトやレコードの権限周りに関する設定値を定義した設計書です。

レポート定義書

レポートの設定値について定義した設計書です。表示項目、検索条件、表示グラフについて記載します。

ダッシュボード定義書

ダッシュボードについて定義した設計書です。参照元のレポートやグラフの種別等を記載します。

フロー定義書

フローの設定値について定義した設計書です。各要素に設定された条件やアクション等を記載します。

承認プロセス定義書

承認プロセスの設定値について定義した設計書です。開始条件、承認ステップ、アクション等を記載します。

メールテンプレート定義書

メールテンプレートの設定値について定義した設計書です。

キュー定義書

キューの設定値について定義した設計書です。

Apexクラス定義書

Apexクラスの仕様や動作について定義した設計書です。標準機能ではないですが、Apexクラスを実装した場合は作成が必要です。

Visualforce定義書

Visualforceで作成したページの仕様やUIについて定義した設計書です。こちらもApexクラス定義書と同様に標準機能ではないですが、Visualforceを実装した場合は作成します。

上記はSalesforce導入に必要な詳細設計書の基本的なものになります。作成しなければいけない設計書は機能や要件によって異なってくるので、これらの設計書では記載しきれない機能がある場合は、それについても設計書を作成する必要があります。

質の高い設計書がもたらすメリット

Salesforceの詳細設計書について理解頂けましたでしょうか？詳細設計書は種類も多く、作成するのは大変な作業ですが、後工程の効率化やシステムの品質向上においてとても重要な役割を担っています。
最後に、質の高い設計書を用意することの重要性について解説したいと思います。主なメリットは下記になります。

• 製造工程の効率化
  設計書に実装内容が詳細に記載されていると、製造工程での考慮事項やミスが減り、製造工程の効率化に繋がります。

• テスト工程の効率化
  前述した通り製造工程でのミスが減るため、テスト工程で検出されるバグの削減に繋がります。バグが発見された時も、期待される仕様や動作を設計書から読み取れる場合が多く、バグの修正作業も楽になります。

• システムの品質向上
  システムの品質はテストの質に大きく左右されます。テスト設計書は製造時の設計書をインプットに作成するため、製造時の設計書が詳細に記載されていると質の高いテストが可能になります。その結果、小さなバグも見つけられるようになるのでシステムの品質向上に繋がります。

• 保守性の向上
  システムを納品後も、一部機能を修正したり追加したりといったメンテナンス作業が発生します。そのときに、実際のシステムと設計書の内容がしっかり一致していると、メンテナンス作業や設計書の修正が容易になり、保守性向上に繋がります。

このように、質の高い設計書によってもたらされるメリットは本当にたくさんあります。良い設計書無しに良いシステムは作れません。設計書を作る時には、設計書の役割や重要性を理解した上で良い設計書を作りましょう！

おわりに

最後までお読みいただきありがとうございました。
今回はSalesforceの詳細設計書と、質の高い設計書がもたらすメリットについて執筆させていただきました。
この記事が参考になったと思った方は、「スキ」を押していただけると嬉しいです！

お問合せはお気軽に

SHIFTについて（コーポレートサイト）
https://www.shiftinc.jp/

SHIFTのサービスについて（サービスサイト）
https://service.shiftinc.jp/

SHIFTの導入事例
https://service.shiftinc.jp/case/

お役立ち資料はこちら
https://service.shiftinc.jp/resources/

SHIFTの採用情報はこちら

PHOTO：UnsplashのDose Media