ヴェルク - IT起業の記録

受託開発と自社サービスの両立への取り組み

boardのカスタマーサポート返信時にtextlintでチェックする

boardのサポートチームが回答する際に、textlintを使って自動的に文章をチェックするようにしたら、とてもいい感じだったので紹介します。

textlintについて

日本語の文章をチェックするためのlinterで、たとえば、「ら抜き言葉」「NGワード」「文章が冗長」などをチェックできるので、機械的にチェックできることはtextlintに任せて、人はそれ以外の部分に集中するということができます。 

boardでは、2019年からヘルプの校正でtextlintを使っており、とても重宝しています。(下記の記事執筆時はCircleCIでしたが、現在はGitHub Actions) 

tamukai.blog.velc.jp

ちなみにヴェルクでは、GitHub Sponsorsを使ってtextlintを支援しています。それくらい欠かせない存在。

tamukai.blog.velc.jp

 

サポートからの返信時にtextlintでチェック

boardのサポート窓口のツールは、以前はintercomを使用していましたが、2021年4月に自前開発のものに置き換えたので、そこにtextlintを組み込みました。

tamukai.blog.velc.jp

 

サポートからの回答時に「ひと呼吸」置いて送信できるように、「送信前の確認」ダイアログを表示しているので、そこにtextlintでチェックした結果を表示するようにしました。
回答の文章をtextlintでチェックした結果のアラートが表示されているスクリーンショット

1文に無理矢理押し込めた非常に読みにくい文章ですが、上記のようにアラートが出るので、見直すためのきっかけを与えてくれます。

 

また、たとえば、以下のようなことも防止できるので、安心感があります。

  • 少し前に、カタカナの表記ルールの変更(例:ユーザ→ユーザー)をしたのですが、それを機械的にチェックできる
  • NGワードとしてステージング環境のURLなどを設定しているので、これにより、ヘルプのURLを送る際に、ステージング環境のURLを送ってしまう事故を防げる

 

ちなみに、実装については下記参照。

shrkw.hatenablog.com

 

気にしないといけないことを減らす

サポート対応時、考えないといけないこと、考慮しないといけないことが非常にたくさんあります。たとえば、問い合わせ内容に加えて、以下のような点を考慮しながら回答を書いていきます。

  • 問い合わせしてきた方のユーザー権限
  • 登録したばかりのアカウントなのか、それともある程度使っているのか
  • 長く使っている会社でも、新しいユーザーではないか
  • 過去の問い合わせを確認して関連がないか、その他、業務において特徴的な点や読み取れる背景はないか
  • 何人でboardを使っているのか
  • ブラウザやOSなどの利用環境

その上で、当然ながら、日本語や文章として間違いがないか、読みにくくないか、などの確認します。

人は、いつでも同じ集中力を維持し続けるということは無理だと思っているので、機械的に補助できるところは積極的に補助していき、より本質的な部分に注力できるようにしていきたいと考えています。
サポート対応の中では、textlintによるチェックは、この「機械的に補助できる部分」であり、これをシステムに任せられることで、「気にしないといけないこと」を1つ減らすことができます。

 

実際に使ってみた感想

textlint自体は、2年以上前からヘルプの校正で使ってきていますが、ヘルプの方はCIでチェックしている関係上、「必ず通ること」を前提として運用しているので、ルールはわりと保守的に設定しています。一方、サポート返信時のチェックでは、その時点でエラー内容を確認した上で「そのまま回答する」という判断もできるので、積極的に様々なルールを組み込んでみています。

数週間ほど運用してみて、サポートチームからは「文章が冗長で、もっとシンプルに書けることに気づいた」という反応が多くて興味深かったです。

しばらく使ってみて、ルールの見直しなどは行うと思いますが、ひとまず、とてもいい感じです。

 

ちなみに、現在、カスタマーサポートのメンバーを募集中です。ご興味がある方はお気軽にご連絡ください。

tamukai.blog.velc.jp

 

余談

このブログを書くのに、Shodoを使ってみました。個人ブログなのでレビュー機能は使っていませんが、AI校正によるチェックだけでもかなり助かります。そして書き心地もとても良かったです。

shodo.ink