diff --git a/content/articles/products/contents/how-to-use.mdx b/content/articles/products/contents/how-to-use.mdx new file mode 100644 index 000000000..ce5a63629 --- /dev/null +++ b/content/articles/products/contents/how-to-use.mdx @@ -0,0 +1,35 @@ +--- +title: 'ライティングガイドラインの使い方' +description: ' ' +order: 1 +ignoreH3Nav: true +--- +## ライティングガイドの使い方 +ライティングガイドは、絶対に守らないといけない規則ではありません。 +あくまで言葉をデザインするときの指針として利用し、ユーザーにわかりやすさを提供できる表現かどうかを都度確認する姿勢を大切にしてください。 + +## ライティングガイドラインの構成 + +### 基本的な考え方 +言葉をデザインするときの基本的な考え方をまとめています。 +用字用語やUIテキストと言った具体的なガイドラインは基本的な考え方に基づいて決められています。 + +都度チェックリストのように参照するのがおすすめです。 +UI文言やヘルプページ・リリースノードなど、ユーザー向けに書いたものがわかりやすい表現になっているかを確認できます。 + +### 用字用語 +文章を書くときに用いる字（平仮名、カタカナ、漢字、英数字）と用いる語（単語、熟語）について、推奨する表記とNG例、その理由を定義しています。 + +用字用語では、索引と詳細ページを用意しています。どの詳細ページに記載があるかわからない場合には、索引で調べてください。 +表記揺れで迷った場合などに参照するのがおすすめです。 + +### UIテキスト +用字用語とは別に、アプリケーション上の表現で迷ったときの判断基準や、推奨する表記を記載しています。 + +UI文言の検討前に、該当するガイドラインがありそうか、UIテキストのページを確認すると便利です。 + +### ヘルプページ +ヘルプページの目的と各種ヘルプページの表記ルールを記載しています。 + +### リリースノート +リリースノートの目的と表記ルールを記載しています。 diff --git a/content/articles/products/contents/index.mdx b/content/articles/products/contents/index.mdx index d91a3b9a1..b74f6d57a 100644 --- a/content/articles/products/contents/index.mdx +++ b/content/articles/products/contents/index.mdx @@ -8,26 +8,46 @@ import { PageIndex } from '@Components/article/PageIndex' UIテキストに限らず、**「ユーザーがSmartHRというプロダクトを利用する際に助けとなる言葉をデザインする」**ためのツールを提供します。 - - - ライティングガイドラインの位置づけについてまとめています。 - - - 言葉をデザインするときの判断基準や表記ルールをトピックごとに記載しています。 - - - 文章を書くときに用いる字（平仮名、カタカナ、漢字、英数字）と用いる語（単語、熟語）について、推奨する表記とNG例、その理由を定義しています。 - - - アプリケーション上の表現で迷ったときの判断基準や、推奨する表記を記載しています。 - - - エラーメッセージについての考え方とライティングパターンを記載しています。 - - - ヘルプセンターの目的と各種ヘルプページ、リリースノートの表記ルールを記載しています。 - - +ライティングガイドラインは、SmartHRのプロダクトで表記する言葉についての指針を示したものです。 + +[デザイン原則](/products/principles/)に基づき、わかりやすく統一感のある言葉を誰でも迷わずに決定できる状態を目指します。 +「わかりやすい」の定義については、[UXライティング部のビジョン](https://smarthr-inc.docbase.io/posts/2438010)を参照してください。 + +### 適用範囲 +SmartHRのプロダクトで表記する言葉すべてです。 +プロダクトとは、アプリケーションだけでなく、ヘルプセンターなど、ユーザーがSmartHRを使うときに触れるものすべてを指します。 + +![プロダクトが指す範囲](./images/Contents_Concept.png) + +### ライティングガイドを通じて実現したいこと +#### ユーザーの読解の負荷を軽減する +ユーザーは「年末調整を円滑に実施したい」など、ある目的を持ってプロダクトを操作します。 +プロダクト上の言葉がわかりづらいと、その言葉そのものを読解することにユーザーは注意を払うことになり、本来の目的である「年末調整を円滑に実施する」ことに集中できなくなってしまいます。 + +読解の負荷を軽減する言葉を選ぶことで、ユーザーが本来の業務に集中できる体験を提供します。 + +#### 日本語の曖昧さが生むズレを埋める +日本語は、一人称が「私」や「僕」など複数の表記があったり、同音異義語が多かったりと、言葉のばらつきが起きやすい曖昧な言語です。 +また、人が無意識に使う言い回し、言葉の選び方にはクセがあり、意識しないと表記を統一できません。 + +一定のルールを設けることで日本語の曖昧さが生むズレを埋め、統一感のある言葉を使用したプロダクトを提供します。 + +### ライティングで重視する観点 + + +ライティングガイドは「日本語スタイルガイド 第3版」を参考に、下記の観点でプロダクトを操作するユーザーの読解の負荷を軽減する言葉を定義します。 + + +#### 一貫性 +この画面では「hogehoge」と表記されているが、別の画面では「hogefuga」と表記されているといった、表現のばらつきをなくします。 +#### 統一感 +プロダクト上で使用する言葉を統一し、画面ごとに雰囲気が違うといった違和感をユーザーに与えません。 +#### 検索性 +ユーザーが必要な情報に辿り着きやすい構造にしたり、馴染みのある言葉を使います。 +#### 標準化 +言葉を決める際の根拠を公開することで、プロダクトに関わる誰もが個人のスキルや好みなどに依らずに一定の品質で言葉を決められるようにします。 +#### 効率化 +開発スピードが加速するように、必要な言葉をスムーズに決定できるライティングパターンや事例を公開します。 ## フィードバック先 記載内容に気になる点がある場合は、社内Slack`#design_system_相談`チャンネル、または、お近くのUXライターまでお願いします。 diff --git a/content/articles/products/contents/writing-principles.mdx b/content/articles/products/contents/writing-principles.mdx deleted file mode 100644 index 203628ed7..000000000 --- a/content/articles/products/contents/writing-principles.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: 'ライティングガイドラインの使い方' -description: ' ' -order: 1 ---- - -ライティングガイドラインは、SmartHRのプロダクトで表記する言葉についての指針を示したものです。 - -[デザイン原則](/products/principles/)に基づき、わかりやすく統一感のある言葉を誰でも迷わずに決定できる状態を目指します。 -「わかりやすい」の定義については、[UXライティング部のビジョン](https://smarthr-inc.docbase.io/posts/2438010)を参照してください。 -### 適用範囲 -SmartHRのプロダクトで表記する言葉すべてです。 -プロダクトとは、アプリケーションだけでなく、ヘルプセンターなど、ユーザーがSmartHRを使うときに触れるものすべてを指します。 - -![プロダクトが指す範囲](./images/Contents_Concept.png) - -### ライティングガイドを通じて実現したいこと -#### ユーザーの読解の負荷を軽減する -ユーザーは「年末調整を円滑に実施したい」など、ある目的を持ってプロダクトを操作します。 -プロダクト上の言葉がわかりづらいと、その言葉そのものを読解することにユーザーは注意を払うことになり、本来の目的である「年末調整を円滑に実施する」ことに集中できなくなってしまいます。 - -読解の負荷を軽減する言葉を選ぶことで、ユーザーが本来の業務に集中できる体験を提供します。 - -#### 日本語の曖昧さが生むズレを埋める -日本語は、一人称が「私」や「僕」など複数の表記があったり、同音異義語が多かったりと、言葉のばらつきが起きやすい曖昧な言語です。 -また、人が無意識に使う言い回し、言葉の選び方にはクセがあり、意識しないと表記を統一できません。 - -一定のルールを設けることで日本語の曖昧さが生むズレを埋め、統一感のある言葉を使用したプロダクトを提供します。 - -### ライティングで重視する観点 - - -ライティングガイドは「日本語スタイルガイド 第3版」を参考に、下記の観点でプロダクトを操作するユーザーの読解の負荷を軽減する言葉を定義します。 - - -#### 一貫性 -この画面では「hogehoge」と表記されているが、別の画面では「hogefuga」と表記されているといった、表現のばらつきをなくします。 -#### 統一感 -プロダクト上で使用する言葉を統一し、画面ごとに雰囲気が違うといった違和感をユーザーに与えません。 -#### 検索性 -ユーザーが必要な情報に辿り着きやすい構造にしたり、馴染みのある言葉を使います。 -#### 標準化 -言葉を決める際の根拠を公開することで、プロダクトに関わる誰もが個人のスキルや好みなどに依らずに一定の品質で言葉を決められるようにします。 -#### 効率化 -開発スピードが加速するように、必要な言葉をスムーズに決定できるライティングパターンや事例を公開します。 - -### ライティングガイドの使い方 -ライティングガイドは、絶対に守らないといけない規則ではありません。 -あくまで言葉をデザインするときの指針として利用し、ユーザーにわかりやすさを提供できる表現かどうかを都度確認する姿勢を大切にしてください。 - -ユーザーが判断に迷わない表現をするために、用いる字（平仮名、カタカナ、漢字、英数字）や語（単語、熟語）を、［用字用語］として整備しています。 -[用字用語](https://smarthr.design/products/contents/idiomatic-usage/)から確認してください。