よりよい文書を書くための校正ツール「textlint」のSmartHR用ルールプリセットを公開しました!|SmartHRオープン社内報
見出し画像

よりよい文書を書くための校正ツール「textlint」のSmartHR用ルールプリセットを公開しました!|SmartHRオープン社内報

おつかれさまです。プロダクトデザイングループのこぎそ(@kgsi)です。みんなのデザインシステムことSmartHR Design Systemプロジェクトの一環として、より良い文書を書くための校正ルール「textlint(テキストリント)」のSmartHR用ルールプリセットをオープンソースで公開しました!

SmartHR用ルールプリセット公開の背景

SmartHRのバリューには「一語一句に手間ひまかける」と、SmartHR Design Systemのデザイン原則の中でも「言葉からはじまるデザイン」と表されていますが、改めて、SmartHRは「言葉」をとても大切にしている会社ですよね。

UXライティングチームを中心に、日々文言ガイドラインが整備され、SmartHRの扱う言葉は進化しています。整備対象は各部署共通で使う文言から、ヘルプページ、プロダクトで使う文言まで多岐にわたっています。

画像1

▲ スプレッドシートで運用している文言ガイドライン

文言ガイドラインが整備されそれが守られることは、プロダクトや関連するドキュメントの品質向上につながるため、とても価値のあることです。
しかし、プロダクトの成長に伴い守るべきルールが増えてきており、目視や人の手によって行なう確認ではルールを守ることが難しくなってきているな、と感じていました。

エンジニアリングの力を使って、文言ガイドラインを誰でも効率的に、そして楽に守っていけるようにできないか?と考え、社内のエンジニア、UXライターと協力して、SmartHR用ルールプリセットを作成・公開する運びとなりました。

そももそもtextlint(テキストリント)ってなに?

プログラム界隈でいわゆる「linter」と言われるツールの一種です。本来はプログラム記述の誤りを指摘したり、修正したりするためのツールですが、その考え方を自然言語(人間が読んだり話したりする言語のこと)に応用して、対象文書の誤りの指摘や、修正ができるようにしたツールです。@azu_reさんという方が作っています。

textlintは文書校正機能の提供はしているものの、校正するためのルールや単語辞書などは自前で用意する必要があります。文言ガイドラインのルールを共通化し、社員や、関連する方々、誰もがSmartHRらしい文章を書けるようにするために、まずはルールプリセットをオープンソースで公開しました。

設定ルールの紹介

textlintは2021年現在、200弱のルールがオープンで公開されています。SmartHR用ルールプリセットは社内で作られた文言ガイドラインに従い、別途一般に公開されているルールと組み合わせ、カスタマイズすることで制作しています。利用している代表的なルールを一部抜粋して紹介します。

ja-no-redundant-expression
「することができる→できる」のように、なくてもいい・ないほうが読みやすい表現をチェックします。

preset-ja-spacing
日本語周りにおけるスペースの有無についてのプリセットです。英語・日本語間のスペースを取るために使っています。SmartHRのプリセットでは、半角英数字と日本語の間にはスペースを入れないルールにしています。

ja-hiragana-keishikimeishi
ひらがなで表記したほうが読みやすい形式名詞を指摘してくれます。

他の設定ルールの情報は、READMEの「設定ルール一覧」を参照してください。
また、ルールとは別に、単語表記のゆらぎを防ぐためのスペルチェッカー(textlint-rule-prh)が設定されています。設定されている辞書を確認したい場合は、GitHubに格納されたymlファイルを確認してみてください。

使い方

SmartHR用ルールプリセットは、npmというオープンなパッケージ管理ツールで公開されているため、これを通して利用が可能です。textlintパッケージ以外の依存はなく、設定も各プロダクト機能ごとに自由に設定できます。

textlint自体の詳しい設定・使い方は、以下のドキュメントを参照してくださいね。

お願いしたいこと

リリースされたばかりなので、運用のノウハウが圧倒的に不足している状況です。そのため、各プロダクトや機能開発で使っていただき、フィードバックをください! バグフィックスや各種要望などを受け付けたいと思います。

【フィードバック方法】
Slackチャンネル # pj_smarthr_textlint で @group-textlint-dev 宛にメッセージを送信してね。

課題と今後のロードマップ

SmartHR用ルールプリセットは以下の目的のもと、開発を続けています。

● 開発・コンテンツ制作を「最短距離」で行えるようにするため
● (SmartHRの)世界観統一のため
● 品質向上のため

目下の課題は、安定した更新体制の確立と、実運用に必要な設定方法やナレッジを蓄積していくことです。
また、これはまだ先の課題となりますが、今はtextlintのルールプリセットのみでしか文書校正の仕組みを提供しておらず、プログラムが分かる人にしか恩恵が受けにくい状況です。

誰でもSmartHRらしい文言が書けるようになるためには、周辺ツールの開発や、それに伴うナレッジの共有が不可欠だと考えています。

今後のSmartHR用ルールプリセットの開発、さらに言えばSmartHR Design Systemの活動にご期待ください! 応援してね。

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

オープン社内報

嬉しいです!スキありがとうございます!
クラウド人事労務ソフト「SmartHR」を運営する、株式会社SmartHRのアカウントです。 “誰でも読める社内報”として、「オープン社内報」で福利厚生や社内制度など、SmartHRの社員向け情報を発信しています。