ライティングガイドラインをSmartHRのUXライター全員で作ってみたら

SmartHR Design Systemには「コンテンツ」と呼ばれるセクションがあります。用字用語やUIテキストといったUXライティングに関するガイドラインがまとめられています。

コンテンツの中身は、UXライティンググループのメンバーが有志で制作しています。多くは、制作の主体となる人を1人決め、他のメンバーは壁打ちやレビューなどに協力し、作りあげていきます。

今回は、そうした進め方を変えて、あえて全員を巻き込んで作るという方法をとってみました。

作業時間が確保できず、心のバックログにしまう

今回作ったのは、ヘルプページのガイドラインである「仕様の一覧の書き方」です。

仕様の一覧の書き方 | ヘルプセンター | SmartHR Design System

「ヘルプセンター」のなかで、ヘルプページは情報の種類ごとに、下記のタイプに分類されています。

• 概要

• 操作手順

• 仕様の一覧

• トラブルシューティング・FAQ（よくある質問）

これまで「仕様の一覧」だけ書き方のガイドラインがなく、このまま永久欠番なのかな、と個人的にずっと気になっていました。しかし、作るのに時間がかかりそうで、着手できずにいました。

ライティングガイドラインは、扱う情報によって必要な作業時間がけっこう変わります。

例えば、用字用語は、推奨する書き方を定義すれば、あとはフォーマットに沿って追加すれば完了する場合が多いです。過去に検討した「理由」によって考え方がある程度明文化されていたり、決めの問題というケースもあったりするので、あまり時間はかかりません。

一方、ヘルプページの書き方などは推奨する書き方を定義する前後に、やることがたくさんあります。

より抽象度の高い「考え方」を言語化・整理したり、既存のページを調査し、傾向を抽出したり。考え方・既存の文言の傾向・書き方を紐づけながらガイドラインを組み立てていきます。（このあたりは書籍「ちいさくはじめるデザインシステム」にも詳しく書かれています。）

ガイドラインとしてのまとめ方も検討する必要があります。フォーマットに沿えばOKというケースは少なく、どうなっていると参照しやすいかも検討します。

なので、完成までにわりと時間がかかります。「仕様の一覧の書き方」も後者のプロセスに当てはまるものなので、時間がかかるだろうなあと思っていました。そして、心のバックログに仕舞ったままに…。

じっくり共有会を活用し、負荷分散を試みる

「いや、全員で作れば意外と簡単にできるのでは？」

じっくり共有会の次なるトピックを探しているときに、そんなことをひらめきました。

じっくり共有会とは、UXライティンググループで運用しているナレッジシェアの仕組みです。メンバーが発散的に話すことで暗黙知の言語化をめざす場です。アウトプットに残らず、暗黙知になりやすい「考え方」は、これまでもじっくり共有会の定番トピックでした。

なので、「仕様の一覧の考え方もみんなで話せば、あっというまに言語化できるのでは？」と思ったのです。実際にじっくり共有会の場でグループ全員を巻き込んでガイドラインを作るという方法を試してみることにしました。

▼じっくり共有会については、より詳細な説明を書いた記事もあります。

具体的には、以下の流れで進めていきました。

第一回：具体例の調査

「仕様の一覧の書き方」が公開されるまでは、「仕様の一覧」を「リファレンス」と呼んでいました。なんとなく「こういったヘルプページのことをリファレンスと呼ぶのだろう」という認識はあったものの、どこまでをガイドラインの対象として含めるのかが不明確でした。

そこで、担当プロダクトのヘルプページ内にある「リファレンス」と呼びそうなページをそれぞれ調査してじっくりに持ち寄りました。じっくり共有会では、持ち寄ったページを分類し、型化できそうな分類群に目星をつけました。

第二回・第三回：テンプレート（推奨する書き方）の制作

前回、型化できそうと目星をつけた分類群の中から2つ選び、テンプレートを作成してみる会を2回実施しました。

具体のテンプレートを作ってみることで、いきなり抽象的なテーマで話すよりも「こういった判断をしている」という暗黙知を言語化してもらおうという狙いがありました。

第四回：考え方の言語化

最終回では、抽象的なテーマとして「リファレンスはどこまでのページを指すか？」という議論をしました。

ここで、「リファレンスとは一覧である」という共通認識が固まり、「リファレンス」という呼び名を「仕様の一覧」に変更したいという話が出てきました。

このあとは、じっくりで話した共通認識をガイドラインとしてまとめる作業を私が担当しました。まとめた原稿をじっくりに参加したメンバーにレビューしてもらい、最終調整をしたあとに公開しました。

やってみてどうだったか

狙い通り、作成の速度が早まりました。

複数プロダクトを横断して調査する作業を担当プロダクトごとに分担できたのは特に大きかったと思います。また、じっくり共有会では毎回3グループに分けて議論していたため、グループごとに異なる検討観点で意見だしができていました。それにより短期間で、内容の精度も高められました。

さらに、ガイドラインに対する認識が揃うという副次的なメリットも。ガイドラインを1人で作るとその後の周知や浸透が必要になります。今回は全員が関わっているので、ガイドラインができた瞬間からUXライター全員がガイドラインを使える状態が作れています。

こうした進め方を試せたのは、じっくり共有会という場があったこと以上に、UXライティング自体を探究しようとしているメンバーが複数いるからこそだと思っています。UXライティンググループは現在14名おり、それぞれバックグラウンドや得意とすることもさまざまです。「書く」という仕事を、広く深く探究していくのにありがたい環境だなあと改めて実感した出来事でした。

UXライティンググループに興味が湧いた方はぜひ採用ページものぞいてみてください。