Skip to content

Instantly share code, notes, and snippets.

@tadyjp
Last active January 28, 2019 03:55
Show Gist options
  • Select an option

  • Save tadyjp/c67a0f504817a14f3c28 to your computer and use it in GitHub Desktop.

Select an option

Save tadyjp/c67a0f504817a14f3c28 to your computer and use it in GitHub Desktop.

Revisions

  1. tadyjp renamed this gist Mar 7, 2016. 1 changed file with 0 additions and 0 deletions.
    File renamed without changes.
  2. tadyjp created this gist Mar 7, 2016.
    196 changes: 196 additions & 0 deletions gistfile1.txt
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,196 @@
    # <i class="fa fa-cubes" style="font-size:1em;"></i> はじめに

    formrun (フォームラン)という「**急なフォームの設置を依頼されたときに短時間で導入できるお問い合わせフォーム**」を作ったので,具体的な利用例のコードを紹介したいと思います。

    https://form.run/ <i class="fa fa-external-link"></i>

    # <i class="fa fa-users" style="font-size:1em;"></i> 対象の読者

    - フォーム設置にストレスを感じたことのある**エンジニア・デザイナー**

    # <i class="fa fa-bug" style="font-size:1em;"></i> 背景


    <img width="765" alt="Screen Shot 2016-03-04 at 6.15.38 PM.png" src="https://qiita-image-store.s3.amazonaws.com/0/10272/117a4d51-6f4b-d377-c5ce-39fda24b624c.png">


    IT企業にお勤めのエンジニアの中で、
    **お問い合わせフォーム**の設置を意味不明な納期で依頼されるという経験はありませんか?
    (私の日常の中では、年に数回ほどそのような依頼を社内から受けることがあります。)

    例えば、
    「**コーポレートページのお問い合わせを新設したいからフォーム付けといて**」とか、
    「**採用エントリー20xx年版の公開をしたいからフォーム作って**」とか、
    「**資料請求用のフォームを設置しといてよ**」
    というような依頼がくるわけですね。

    しかもほとんどの場合、その依頼はリリースが間近に迫ってからではありませんか?

    なぜなら、こういった依頼者はGoogleフォームのような、いわゆるビルダー系のツールに慣れており、
    ちょっとフォーム項目を追加・削除することなど、自社が誇るエンジニアにとっては、朝飯前だと考えているのでしょう。

    しかし、たいていの場合は依頼者側(管理部門や人事部など非開発者の場合が多い)には悪意がなく、
    仕方なく残業をして締め切りに間に合わせる、というのが実態ではないでしょうか?

    フォームの作成・項目変更には多くの場合、DBスキーマの変更や、通知メールの設定など、「**目に見えないタスク**」が潜んでいるので,そう簡単には変更できないんですよね。


    そんな、社内の情報格差によって生じる事件を少しでも和らげたいという思いから、「formrun(フォームラン)」というサービスを作りました。



    # <i class="fa fa-thumbs-o-up" style="font-size:1em;"></i> 概要

    「formrun(フォームラン)」はフォームからサーバへ送信するための `jsスクリプト` と、
    そこから送られた問い合わせデータをグラフィカルに管理することができる `管理画面` の2つの部分から成る `SaaS`です。

    `BaaS` とは異なり、データを受け付けた後の「運用」まで考えたサービスになっております。

    動画 <i class="fa fa-video-camera"></i> https://s3-ap-northeast-1.amazonaws.com/tady-monosnap/screencast_2016-03-04_13-30-31.mp4

    「運用」のための管理画面では、いわゆる「**かんばん**」風に操作することができるため、
    「**あのユーザーからの問い合わせ、きちんと返信したっけ?**」とか
    「**この問い合わせはクレームにつながりそうだから、上長のxxさんにレビューしてもらおう**」といったように、担当者同士の二重対応や対応漏れといったリスクを低減することができる構成になっています。




    # <i class="fa fa-cogs" style="font-size:1em;"></i> 使い方

    ## <i class="fa fa-check-square-o" style="font-size:1em;"></i> フォーム設置

    大抵の場合は既存のフォームがある方は2箇所のコードを変更するだけでOKです。

    1. `<form>タグ` の `class` に `formrun` を追加し、フォーム送信先を指定したURL(管理画面で発行できます)に変更します。
    2. そして、`<script>タグ`をページ内で読み込むだけです。

    フォーム内の`name属性`がそのまま運用時の項目名となるため、運用のことを考えて読みやすい表記に変更するといいと思います。

    HTMLやスタイルは自由に設定することができるので、**EFOツール**や自前の**バリデーションライブラリ**を併用することもできます。

    もちろん、フォーム送信後の「サンクスページ」は自由にURLを設定できるので、Googleフォームとは違い、**コンバージョン**を測定することもできます。

    ```html
    <!-- [1] classとactionを変更します -->
    <form class="formrun" action="https://form.run/api/v1/r/xxxxxxxxxxxxxxx" method="post">

    <!-- ↓自由に要素を追加・編集することができます -->
    <label>お名前
    <input name="お名前" type="text">
    </label>

    <label>メールアドレス
    <input name="メールアドレス" type="email">
    </label>

    <label>お問い合わせ
    <textarea name="お問い合わせ"></textarea>
    </label>

    <button type="submit">送信</button>
    </form>

    <!-- [2] formrun用スクリプト -->
    <script src="https://form.run/js/v1/sdk.js"></script>
    ```

    設定の様子 <i class="fa fa-video-camera"></i> https://s3-ap-northeast-1.amazonaws.com/tady-monosnap/screencast_2016-03-04_13-27-18.mp4


    ## <i class="fa fa-user"></i> 運用

    フォームから送られてきたデータ(以下、エントリー)は、「ボード画面」の一番左のステータスが自動的に設定されます。一般的なお問い合わせでは、複数人の担当者がいらっしゃると思いますので、「担当者機能」や「メモ機能」を活用することで、タイムリーに対応することができ、タスクの抜け漏れを防ぐことができます。

    また、「リスト画面」では、Excel風の一括編集も使えるので、いちいち「エクスポートしてExcelで編集後にアップロード」といった手順を踏むことなく、大量のリスト管理をストレスなく行うことができます。

    ![kanban 2016-03-07 00-03-52.png](https://qiita-image-store.s3.amazonaws.com/0/10272/c578df4e-d62d-feaa-d7de-b5673175092d.png)


    「ボード」のサンプル <i class="fa fa-video-camera"></i> https://s3-ap-northeast-1.amazonaws.com/tady-monosnap/screencast_2016-03-04_13-36-20.mp4

    「一括置換」のサンプル <i class="fa fa-video-camera"></i> https://s3-ap-northeast-1.amazonaws.com/tady-monosnap/screencast_2016-03-04_13-33-00.mp4

    ## <i class="fa fa-check-square-o" style="font-size:1em;"></i> zopim風フィードバックフォームの設置例

    formrunを使えば、画面の右や下からにゅっと出てくる、あのzopim風フィードバックフォームを設置することも(比較的)簡単に実装できます。

    ![フォーム設定 | formrun 2016-03-07 13-13-12.png](https://qiita-image-store.s3.amazonaws.com/0/10272/7ef37d77-ca3c-c464-0596-89b916a0108a.png)

    実際にformrun内で利用しているフィードバックフォームのコードを一部修正して紹介します。

    サンプルコード全文はこちら http://codepen.io/tady/pen/vGLYpr <i class="fa fa-external-link"></i>

    ```coffeescript
    $(document).ready ->

    feedbackVue = new Vue

    el: '#fr-feedback'

    data:
    feedbackActive: false
    feedbackText: ''
    feedbackFeeling: ''
    feedbackSendComplete: false

    methods:
    clickedFeedBackBtn: ->
    if @feedbackActive
    @feedbackActive = false
    @feedbackSendComplete = false
    else
    @feedbackActive = true

    # NOTICE: このAPIはα版です
    Formrun.SDK.configure 'QHhuekipVeThsGmE8gwU', {
    # フォーム送信後のリダイレクトを停止
    redirectAfterSubmission: false

    # フォーム送信後のコールバック
    afterSubmission: (key, data) ->
    # フォーム送信終了をVueインスタンスに伝える
    feedbackVue.feedbackSendComplete = true
    }
    ```

    formrun管理画面内では部分的なパーツを`Vue`フレームワークで作っています。
    また、まだ試験的α版ですが、formrunの挙動を変更できる `Formrun.SDK` を作っていて、
    今回の場合は、 `redirectAfterSubmission` と `afterSubmission` という設定をすることで、フォーム送信後に別ページへリダイレクトされるのを防ぎ、ページ内にとどまるようにして利用しています。

    ```coffeescript
    # フォーム送信後にページ遷移するか
    # falseにするとページ遷移しないので、別途afterSubmissionの指定が必要
    redirectAfterSubmission: true|false;

    # <フォームキー>, <送信されるデータ>を受け取る関数
    # <フォームキー>はフォーム送信先に指定したURLの末尾の20文字の英数
    afterSubmission: function(key, data) { ... }
    ```

    実際に受け取ったフィードバックをSlackに流すとこのように見えます
    ![Slack 2016-03-07 23-31-47.png](https://qiita-image-store.s3.amazonaws.com/0/10272/37a79052-f6d7-7a95-23d6-3029b88f430c.png)


    # <i class="fa fa-tasks" style="font-size:1em;"></i> 今後の実装の方針

    現在ベータ版ですが、直近では以下の機能の開発を進めようと考えています。

    - 検索機能の拡充
    - In/Out API
    * アプリや既存システムからの直接のエントリー追加
    * Webhookによる既存システムへの連携
    - メンバー管理・権限機能の拡充
    - エントリーに対するメール返信機能


    # <i class="fa fa-shopping-basket" style="font-size:1em;"></i> まとめ

    この「formrun(フォームラン)」によって、より多くのエンジニア・デザイナーの皆さんの工数を削減し、フォームを通じたお問い合わせ対応を効率化する手助けができれば幸いです。

    https://form.run/ <i class="fa fa-external-link"></i>


    # <i class="fa fa-history" style="font-size:1em;"></i> 編集履歴
    - 2016/03/07
    - フィードバックフォームの設置例を追加しました