フロントエンド開発にtextlintを導入しました

こんにちは、小俣です。

私たちは日ごろからシンプルさを大切に、クラウド電話システム「CallConnect」を開発・運用しています。
先日、フロントエンド開発に「textlint」という校正ツールを導入したので、その振り返りをまとめます。

1年ほど前に、ヘルプセンターの文章校正についても記事を書きました。

member-blog.callconnect.jp

その当時からフロントエンド開発にtextlintの導入を検討しており、それが今回実現したことになります。

textlint導入の背景

私たちは、わかりやすい文章を書くことは、より良い製品体験を作る上で重要なことだと考えています。わかりづらい文章によってユーザーさんを困惑させてしまえば、製品体験は悪くなります。

これまでは、私たちが一言一句に注意力を払って、チェックしてきました。
しかし、さまざまな文章ルールを把握して、漏れなくチェックするというのは現実的ではなく、表記ゆれをなくしたり、用語の統一性を担保したりすることが難しくなっていきました。

そこで、校正ツールの活用を検討し、今回の取り組みに至りました。

textlintは、自然言語に対する静的解析ツールです。
「linter」と呼ばれるツールのひとつで、推奨される書き方など、文章で間違っている部分などを自動的に検知して指摘してくれるツールです。

github.com

今回、フロントエンド開発にtextlintを導入したことにより、CallConnectの各種ページの文言や、管理画面上で表示されるエラー文言などのすべてが、textlintでのチェック対象となりました。

いざ導入してみると...

textlint導入にあたっては、まずどういうルールを適用するか、そのルールを決める必要があります。
自社サービス内で使ってきた表現、文言ルールをベースにゼロから作っていくことも可能ですが、GitHub上に多くのルールが公開されていたため、それらを活用して、自社向けに調整していくことにしました。

実際にtextlintを導入してみると、960個ほどの指摘箇所が検知されました。

例えば、英語・日本語間のスペース有無だったり、ひらがな表記した方がいい文言だったりと、サービスリリースから8年以上が経って、チェックしきれていなかった部分が浮き彫りになりました。

あとは、これらを地道にひとつ一つチェックしていく過程になりますが、「修正するのか、ルール適用外とするのか」の判断にかなりの時間がかかりました。また、適用ルールの調整で、一部例外とする部分の切り分けに苦労しました。
労力はかかりましたが、自分たちがどういう表現をしてきたかを振り返る良い機会になったと思います。