見出し画像

ライティングガイドラインを分類し直し、構成を見直しました！

稲葉志奈

2024年10月10日、SmartHR Design System内のライティング配下の構成を大幅に変更しました！

実は、半年ほど前からこちらの改善に向けてチクチクと作業をしていました。この記事では、なぜ構成を変えたのか、どう変わったのかをご紹介します。

構成を見直した経緯

SmartHR Design Systemは、最初にサイト構造を設計したうえでコンテンツを埋めていったというようなものではありません。必要に応じてコンテンツを少しずつ拡充してきたという歴史があります。SmartHR Design System内にあるライティングガイドラインも同様です。

それゆえに、コンテンツが増えるに連れ、類似のガイドラインが異なるセクションに格納されたり、セクションの見出しとそのセクションに含まれるコンテンツがズレたりといったことが起こっていました。

とはいえ、ライティングガイドラインを拡充している張本人であるUXライターが利用する分にはあまり問題がありませんでした。しかし、スキル移譲（※）の取り組みが進み、UXライターだけでなくエンジニアもライティングガイドラインを参照する機会が増えています。エンジニアから「どこに何があるか把握するのが難しい」という声が聞こえてくるようになりました。

そこで、スキル移譲の障壁になっているのではないか？という課題感のもと、構成を見直すことにしました。

※スキル移譲
開発チームがUXライティングできるようになるために、UXライターが支援することをスキル移譲と呼んでいます。スキル移譲の実施背景や具体的な内容については過去の記事で紹介しているので、ご興味ある方は読んでみてください。

どのように変わったのか

今回の改善で解決したかったのは、エンジニアが目当てのライティングガイドラインをうまく見つけられないという課題です。そのため、構成案のたたきをつくり、エンジニアにもヒアリングに協力してもらいました。

最終的に公開された構成はSmartHR Design Systemの実際のサイト上で見ていただければと思います。ここではポイントを絞って、改善の内容をいくつかご紹介します。

散らばっていた表記に関するガイドラインを用字用語に集約

用字用語やUIテキスト、ライティングスタイルと言った複数のセクションに分かれており探しづらくなっていた表記に関するガイドラインをひとまとめにしました。

もともとは以下のような適用範囲の違いによってセクションを分けていました。

  • 用字用語・ライティングスタイル：ヘルプページやリリースノート、UIテキストなどに広く適用されるガイドライン

  • UIテキスト：UIテキストでのみ適用されるガイドライン。

しかし、「ユーザーにわかりやすさを提供できる表現を優先する」というライティングガイドラインの前提となる考え方に則れば、適用範囲をセクション分けで強調する必要性はなさそうです。

加えて、ライティングガイドラインを参照しているエンジニアにヒアリングをした際に、「ライティングガイドラインを探そうとする場合『あわせて（ひらがな表記）だっけ？合わせて（漢字表記）だっけ？』という状態で探しに行く」という話があがりました。

結果、適用範囲ではなく「表記の迷いどころ」で分類した以下のような案になりました。ただし、この探し方でも難しい場合を考慮して索引も用意しています。

漢字とひらがなの使い分け
カタカナ語の表記
数字・数えの表記
記号（括弧、句点、スペースなど）の表記
SmartHRの用語
操作を表す用語
コンポーネントの呼び方
その他類似する用語の使い分け

UIを考えるうえで重要だが、用字用語に該当しないガイドラインは「UIテキスト」に集約

UIテキストを書く場合には、用字用語だけでは不十分です。例えば、助詞の使い方やページタイトルの記載、エラーメッセージの考え方など、UIテキストに関するガイドラインには用字用語におさまらないものも多くあります。

以前、UI文言を検討する際に参照すると良いライティングガイドラインを以下の記事にまとめました。想像以上にたくさんの方に読んでくださり嬉しい限りなのですが、見ていただくとわかるとおり、UIテキストに関するガイドラインも複数の場所に点在していました。

今回の改善で、UIテキストに関するガイドラインが「UIテキスト」配下にすべて収まっています。以前と同様に関連するコンポーネントのページを見た際にも気付けるよう、元のページにも関連リンクとしては残しています。

抽象的な観点を提供する「基本的な考え方」

表記の使い分けなど具体的なガイドラインよりも抽象度の高い考え方を提供する「基本的な考え方」を用意しました。

もともとは「ライティングスタイル」というセクションでした。見出しから内容が想像できないだけでなく、拡充していくなかで具体の表記ルールまで含まれてしまうようになったセクションでした。

用字用語に表記に関するガイドラインを集約することで「基本的な考え方」を同じ抽象度の項目に絞って記載できるようになりました。

ヘルプセンターをヘルプページとリリースノートに分割

こちらはとてもシンプルな変更です。これまで、「ヘルプセンター」というセクションの中にヘルプページに関するガイドラインとリリースノートに関するガイドラインが格納されていました。

しかし、エンジニアからすると「ヘルプセンター＝ヘルプページ」というイメージがあったようで、ここにリリースノートのガイドラインがあると知らなかった、気付けないといった意見がありました。

そこで、ヘルプページとリリースノートのセクションをわけて、それぞれ階層を1つずつあげることにしました。

これからもWIPの精神で

まだ公開して数日ですが、ありがたいことに社内の方から「使いやすくなった、見つけやすくなった」などポジティブな感想をもらっています。

また、これまでと違う分類を試みたことで不足しているガイドラインや、更新すべきガイドラインに気づくこともできました。

今後も、WIPの精神で立ち向かい、目の前の課題を解決するための改善・更新を繰り返していきたいなと思います！

SmartHR Design Systemの運営理念


いいなと思ったら応援しよう！