設計書、作っていますか？

投稿日 2022年7月27日
更新日 2022年8月2日
著者久保学
カテゴリー Marketo

先日、打ち合わせをしていた時のこと。クライアントから

今回作成したプログラムのフロー図をいただけませんか？

と言われ、その時まで自分の前職を忘れていた、元システムエンジニアの久保です。

今回は、Marketoの使用を前提とした、設計書を作成することの重要性についてご説明いたします。

「なくても別に困らないよ」と思ったそこのあなた！
後悔はさせません。ぜひ最後までお読みいただいた上でもう一度お考えください！

なぜ書くのか？

「設計書がないと何が起きるのか」考えてみましょう。
エンゲージメントプログラムを例にご説明します。
ColdストリームからWarmストリームへの遷移数が想定より少なかったことに気づいたあなた。該当のスマートキャンペーンのスマートリストが、

A.配信されたメール内のリンクを3回クリック　and　B.過去40日以内に特定のWebページへ5回アクセスする

という条件になっていたとします。
このとき、「AとBはorじゃなくてand条件でいいのか？」や、「Bは過去40日じゃなくて30日だったかな？」など、疑わしい部分はいくつもあります。
そんなとき、あなたは条件が間違っているかいないかを、どのように判断しますか？

最近、自分で作ったプログラムだったら良いのですが、自分で作ったものでも時間が経過するに従って当時の背景や目的は忘れがちです。ましてや、自分が作ったわけではないプログラムなら、何をもってして「正しい」とするかはますますわかりません。プログラムの中のごく一部の設定だけでも正解がわからないとなると、プログラムの全体像を把握して正しい理解をするということは、非常に困難な作業です。

それは、高度なマーケティング戦略を行なっていればいるほど困難で、かつ問題発生のリスクが高まります。

そんなときにこそ、設計書は非常に役立ちます。
設計書を作成することの最大のメリットは、「保守性の高さ」です。

複雑に関連しているプログラム達を俯瞰して見ることが可能となることが理由です。全体像を把握できるということは、人為的なミスを防止することに対して非常に有効な手段となります。また、上記に挙げたトラブルの例以外にも、プログラムの改善を行う際、どのプログラムが対象なのか？　といった影響調査にも有用です。

何を書くべきか？

A：条件

スマートキャンペーンを始め、作動する上での「条件」となるべき部分をまず「日本語で」説明した上で、Marketo上でどう実装したかという「設定」について書きます。

B：処理内容

きっかけ（トリガーやバッチキャンペーン）に基づいて、何を行おうとしているのか？　これまた、平易な文章でわかりやすく日本語で解説した部分と、実際にどのようにMarketoで「設定」を行なったかの記録を残します。

C：実行タイミング

いつこれが実施されるのか？（トリガーキャンペーンならトリガー、バッチキャンペーンなら実施時間や繰り返すのか等）はい、これも「日本語」と「設定」の両方を！

D：背景（何の目的で作ったのか）

そして最後、もしかしたらこれが最重要かもしれませんが、そもそもこのプログラムが作られた背景は!?　知らない人が見て一発で理解できるように解説するのを忘れないでください。例えば、「ベスト」ではないけど「ベター」な施策にしなければいけない事情があったのだとすれば、その事情も書きましょう。そうしないと、事情を知らない第三者が挙動を正しく理解し、何よりも誤解に基づいて改変してしまわないようにするための情報を必ず記しましょう！　何をするか、だけではなく「どうしてする事になったのか」です。

この４つは必ず記載しましょう。特にdの「背景」は、人事異動などで担当者が変更になった場合に後任の方へ向けて非常に有用な情報ですが、意識しないと漏れてしまいがちです。