見出し画像

【終了しました】Slackbotで簡単に「textlint」が使えるようになりました!|SmartHRオープン社内報

※2021年 11月 2日追記
textlint自体がプロダクトの過半数に導入されたことで一定の成果を出したことと、利用頻度、運用コストを加味した結果、Slackbotでの運用は2021年11月2日に終了しました。

おつかれさまです。プロダクトデザイングループのこぎそ(@kgsi)です。
より良い文書を書くための校正ルール「textlint(テキストリント)」のSmartHR用ルールプリセットをオープンソースで公開して約1ヶ月経ちましたが、エクステンドなサービスとして、誰でも簡単に「textlint」を実行できるSlackbotを2021年4月にリリースしました!

スクリーンショット 2021-05-11 13.45.13

Slackbotの正式名は「須磨 倫子(すま りんこ)」さんです。

Slackbotの開発背景

「textlint」はルールとそれを適用する仕組みです。オープンソースとしての公開から1ヶ月経ち、プロダクトへの導入も試験的ですが、徐々に進んでいます。
一方で「textlint」はその仕様上、実行するための環境構築と設定が必要なため、導入と利用するためのハードルが高いという課題がありました。「便利そうだけど、使い方がよくわからない」なんて声も寄せられていました。

開発者以外のメンバーにも「textlint」を身近に体験し、使ってもらうためにどうすればよいのかずっと考えていましたが、SmartHR社内の圧倒的なSlack利用率と浸透性(400名のメンバーで、日に1万件以上のメッセージが飛び交っているのすごい)に目をつけた方から「Slackbotで提供すれば良いんじゃない?」というフラッシュアイデアをもらい、約1週間でテストと実装を済ませ、Slackbotを社内で公開する運びとなりました。

使い方

(1)使いたいチャンネル(どこでもOK)で、[/invite @textlint] と投稿してtextlintアプリをチャンネルに追加してね。

(2)「@textlint チェックしたい文書」の形式でメッセージをSlack投稿します。

(3)Slackを介して送信されたメッセージが、ホスティング先サーバー内で動いている「textlint」を通してチェックされ、結果がスレッドに自動で投稿されます。

画像2

技術的な補足

このSlackbotはSlackが提供するBoltというフレームワークを使って開発しています。実装コードはパブリックに公開していますので、よかったら見てね。(改善のためのPull Requestも受け付けています!)

注意点

利用開始からさまざまな場面で使われ始めたSlackbotですが、いつくか注意点があります。

● 「SmartHRの文言ガイドラインとして、現時点で明文化されてるものに合ってるか合ってないか」を判定しています。裏を返すと「本当はガイドライン化したほうがいいけど、まだ決まってないルール」はスルーされます。
ビジネス文書として正しいか、敬語として正しいか、といった観点でのチェックはできません。

「textlint」が文書校正においていわゆる「銀の弾丸」のような印象を与えているかもしれませんが、あくまで設定されたルールに従って機械的に文言をチェックしているツール、という前提で使ってくださいね。

現状の利用シーンとしては「SmartHRの文書ルール・推奨表現に従っているか」といった使い方をオススメします!

今後の予定

Slackbotで利用された情報は収集しており、使ってもらっている中で見つけた修正可能な点はピックアップ、随時実装タスク化しています。
対応を予定しているタスクを一部紹介します。

● 単語の校正
● 省略記号のチェック
● 重言のチェック

また、明確な改善点や、気づいていないバグなどへのフィードバックは絶賛受付中です。少しでも気になったことがあったらSlackチャンネル # pj_smarthr_textlint まで共有・報告してもらえると嬉しいです!

今後は得られたフィードバックを元にさらに精度を上げて、皆さんから得られたフィードバックが、プロダクトへの品質にも反映できるような仕組みを目指します!そのためにもどんどん使ってね。

この記事が参加している募集

#オープン社内報

22,555件