From 97190c245108bf976dbac70bc1fb6d2b58a2fb0e Mon Sep 17 00:00:00 2001 From: kuvanov Date: Mon, 6 Jan 2025 21:43:43 +0900 Subject: [PATCH 1/2] =?UTF-8?q?`=E3=83=A9=E3=82=A4=E3=83=86=E3=82=A3?= =?UTF-8?q?=E3=83=B3=E3=82=B0`=E3=81=AE=E3=83=AA=E3=83=B3=E3=82=AF?= =?UTF-8?q?=E5=88=87=E3=82=8C=E4=BF=AE=E6=AD=A3=E3=81=A8=E3=80=81=E3=83=AA?= =?UTF-8?q?=E3=83=B3=E3=82=AF=E5=88=87=E3=82=8C=E3=81=B8=E3=81=AE=E5=AF=BE?= =?UTF-8?q?=E7=AD=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../contents/help-center/basic-rule.mdx | 22 +- .../contents/help-center/error-handling.mdx | 61 +-- .../products/contents/help-center/faq.mdx | 48 ++- .../contents/help-center/help-page.mdx | 21 +- .../products/contents/help-center/image.mdx | 38 +- .../products/contents/help-center/index.mdx | 34 +- .../contents/help-center/overview.mdx | 2 +- .../contents/help-center/reference.mdx | 2 +- .../products/contents/help-center/review.mdx | 2 +- .../contents/help-center/step-by-step.mdx | 54 +-- .../contents/idiomatic-usage/action.mdx | 42 ++- .../contents/idiomatic-usage/component.mdx | 20 +- .../contents/idiomatic-usage/count.mdx | 43 ++- .../contents/idiomatic-usage/hiragana.mdx | 33 +- .../contents/idiomatic-usage/ichiran.mdx | 353 +++++++++--------- .../contents/idiomatic-usage/katakana.mdx | 39 +- .../contents/idiomatic-usage/other.mdx | 38 +- .../contents/idiomatic-usage/symbol.mdx | 68 ++-- .../contents/idiomatic-usage/usage.mdx | 26 +- .../contents/release-note/releasenotes.mdx | 4 +- .../products/contents/ui-text/app-writing.mdx | 28 +- .../contents/ui-text/error-messages.mdx | 25 +- .../products/contents/ui-text/help-link.mdx | 2 +- .../products/contents/ui-text/mail.mdx | 2 +- .../products/contents/writing-style.mdx | 19 +- 25 files changed, 590 insertions(+), 436 deletions(-) diff --git a/src/content/articles/products/contents/help-center/basic-rule.mdx b/src/content/articles/products/contents/help-center/basic-rule.mdx index e8ca6c42a..d7fd5bbb8 100644 --- a/src/content/articles/products/contents/help-center/basic-rule.mdx +++ b/src/content/articles/products/contents/help-center/basic-rule.mdx @@ -25,7 +25,7 @@ order: 2 - 関連する情報は近くに配置する - 見出しや箇条書きを適切に使う -ヘルプページの並び順や構成の考え方については、[ヘルプページの構成](https://smarthr.design/products/contents/help-center/help-page/)を参照してください。 +ヘルプページの並び順や構成の考え方については、[ヘルプページの構成](/products/contents/help-center/help-page/)を参照してください。 ### 正確かつ簡潔明瞭に説明しましょう - ユーザーの状況やアプリケーションの状態を意識して、タイトルや見出しをつける @@ -56,7 +56,7 @@ order: 2 - スクリーンショットを使う場合は、ユーザーに注目させたい部分を囲みや矢印をつけて強調する - スクリーンショットを使う場合は、ユーザーの操作に必要ない部分を取り除く -詳細は「ヘルプページ用の画像」の[スクリーンショット掲載の考え方](../image/#h2-0)を確認してください。 +詳細は「ヘルプページ用の画像」の[スクリーンショット掲載の考え方](/products/contents/help-center/image/#screenshot-posting-policy)を確認してください。 ## 具体的な書き方のヒント @@ -81,7 +81,7 @@ order: 2 囲みには、必要な情報を目立たせる役割があります。一方、本文からは分断されるため、本筋とのつながりが伝わりづらくなることがあります。 -[囲みのガイドライン](https://smarthr.design/products/contents/help-center/help-page/#h3-8)を参照して、本当に囲みが必要かどうかを精査しましょう。 +[囲みのガイドライン](/products/contents/help-center/help-page/#frames)を参照して、本当に囲みが必要かどうかを精査しましょう。 特に、以下の点に注意してください。 - 読み飛ばしてもユーザーの操作に影響しない情報を「注意点」として記載しない @@ -98,6 +98,7 @@ order: 2 操作の前に知っておくべき注意事項は、操作手順の前に記載します。操作手順のあとに記載すると、ユーザーが注意事項に気づくのが遅れて、操作ミスにつながる可能性があります。 +{} #### 関連する情報は近くに配置する 関連する情報は、その関係が読み取りやすいよう近くに配置しましょう。 @@ -112,6 +113,7 @@ order: 2 見出しで情報を切り分けたり、箇条書きで整理したりして、情報のまとまりを把握しやすくしましょう。 +{} #### 表は見やすくメンテナンスしやすい形式で使う 表の列の幅が狭く、縦に長くなりすぎて、見づらくならないように気をつけましょう。 @@ -184,7 +186,7 @@ Tipsや補足などは、できるだけ表外に記載しないようにしま 特に「〇〇してしまった」「残念ながら」など、ネガティブな印象の言葉は避けてください。 -例外として「よくある質問」の見出しには「〇〇してしまった」という表現を使えます。[よくある質問の書き方](https://smarthr.design/products/contents/help-center/faq/)には、「見出しは口語体で、ユーザーからの質問のように表現する」というルールがあります。ユーザーの発言として自然であれば、「〇〇してしまった」という表現を使っても構いません。 +例外として「よくある質問」の見出しには「〇〇してしまった」という表現を使えます。[よくある質問の書き方](/products/contents/help-center/faq/)には、「見出しは口語体で、ユーザーからの質問のように表現する」というルールがあります。ユーザーの発言として自然であれば、「〇〇してしまった」という表現を使っても構いません。 **例** @@ -311,10 +313,10 @@ Tipsや補足などは、できるだけ表外に記載しないようにしま ## ヘルプページのタイプ別の考え方とパターン -[ヘルプページのタイプ](../#h2-1)別に作成時の考え方とライティングパターンをまとめています。 +[ヘルプページのタイプ](/products/contents/help-center/#types-of-help-pages)別に作成時の考え方とライティングパターンをまとめています。 -* [「機能概要」のライティングパターン](../overview/) -* [「操作手順」のライティングパターン](../step-by-step/) -* [「仕様の一覧」のライティングパターン](../reference/) -* [「エラーメッセージごとの対応方法」のライティングパターン](../error-handling/) -* [「よくある質問」のライティングパターン](../faq/) +* [概要の書き方](/products/contents/help-center/overview/) +* [操作手順の書き方](/products/contents/help-center/step-by-step/) +* [仕様の一覧の書き方](/products/contents/help-center/reference/) +* [エラーメッセージごとの対応方法の書き方](/products/contents/help-center/error-handling/) +* [よくある質問の書き方](/products/contents/help-center/faq/) diff --git a/src/content/articles/products/contents/help-center/error-handling.mdx b/src/content/articles/products/contents/help-center/error-handling.mdx index 43ac48157..8cda37589 100644 --- a/src/content/articles/products/contents/help-center/error-handling.mdx +++ b/src/content/articles/products/contents/help-center/error-handling.mdx @@ -4,82 +4,93 @@ description: 'SmartHRヘルプセンターに掲載するヘルプページの order: 6 --- +{} ## エラーメッセージごとの対応方法の種類 -エラーメッセージごとの対応方法は、以下のパターンで作成します。 -* [単一のエラーの原因と対処方法を伝える](#h2-1) -* [いくつかのエラーをまとめる](#h2-2) +エラーメッセージごとの対応方法は、以下のパターンで作成します。 +* [単一のエラーの原因と対処方法を伝える](#single-error-cause-solution) +* [いくつかのエラーをまとめる](#multiple-errors-in-one-article) +{} ## 単一のエラーの原因と対処方法を伝える記事の構成 -1. [質問（タイトル）](#h3-0) -2. [リード](#h3-1) -3. [原因（見出し）](#h3-2) -4. [説明](#h3-3) -5. [対処方法](#h3-4) +1. [質問（タイトル）](#question-title) +2. [リード](#lead-section) +3. [原因（見出し）](#cause-heading) +4. [説明](#explanation) +5. [対処方法](#solution) -### 1.質問（タイトル） +{} +### 1. 質問（タイトル） 文頭に `Q. ` をつけ、エラーの状態を書きます。読みづらい長文にならない限り、基本的にエラーメッセージをそのまま記載します。エラーメッセージは`「　」`で囲みます。 プロダクトのHeadingルールに則り、句点は省略します。 例外的に口語体で表現しますが、`「　」`は使用しません。 -### 2.リード +{} +### 2. リード エラーがどの画面で、どういったときに起きるかなどを簡潔に書きます。タイトルでエラーメッセージを省略した場合には、必ずエラーメッセージを記載します。 本文のスタイルを適用します。 -### 3.原因（見出し） +{} +### 3. 原因（見出し） 文頭に`A. `をつけ、原因を簡潔に記載します。 見出し1のスタイルを適用します。 例外的に口語体で表現しますが、`「　」`は使用しません。 [Headingの見出しの書き方](../../../../products/components/heading/#h2-3)に則り、句点は省略します。 -### 4.説明 +{} +### 4. 説明 原因を詳細に説明します。どのような条件で操作をするとそのエラーが起こるのかを説明します。 本文のスタイルを適用します。 -### 5.対処方法 +{} +### 5. 対処方法 対処方法を書きます。 手順が複数の工程に分かれる場合は、見出しで工程ごとに分割し、操作手順記事と同じルールで記載します。 見出し2と本文のスタイルを適用します。 #### 記載例 -* [Q. 「書類の作成に失敗しました。必須項目の内容を確認してください。」と表示される場合は？](https://support.smarthr.jp/ja/help/articles/360047119273) -* [Q. 評価シート画面で「編集内容の保存に失敗しました。更新権限があるフォームの下書きが存在しません。」というエラーが出ました](https://support.smarthr.jp/ja/help/articles/4411286053273) +- [Q. 「書類の作成に失敗しました。必須項目の内容を確認してください。」と表示される場合は？](https://support.smarthr.jp/ja/help/articles/360047119273) +- [Q. 評価シート画面で「編集内容の保存に失敗しました。更新権限があるフォームの下書きが存在しません。」というエラーが出ました](https://support.smarthr.jp/ja/help/articles/4411286053273) +{} ## いくつかのエラーをまとめた記事の構成 1つの場面で表示される複数のエラーをまとめたいとき。 -1. [タイトル](#h3-5) -2. [エラー](#h3-6) -3. [回答](#h3-7) -4. [説明](#h3-8) +1. [タイトル](#title-for-multiple-errors) +2. [エラー](#error-heading) +3. [回答](#answer-heading) +4. [説明](#explanation-for-multiple-errors) -### 1.タイトル +{} +### 1. タイトル エラーが表示される場面を明記し、「エラーメッセージ」をタイトルに含めます。 - XXXX時のエラーメッセージ - XXXXで表示されるエラーメッセージ -### 2.エラー - +{} +### 2. エラー 文頭に `エラー` をつけ、エラーメッセージを`「　」`で囲みます。エラーメッセージが複数の文で構成されている場合は、最初の文を抜粋しても構いません。 見出し1のスタイルを適用します。 -### 3.回答 +{} +### 3. 回答 単一のエラーの原因と対処方法を伝える場合の見出しと同様。 見出し2のスタイルを適用します。 -### 4.説明 +{} +### 4. 説明 単一のエラーの原因と対処方法を伝える場合の説明と同様。 本文のスタイルを適用します。 #### 記載例 -* [評価シート入力時のエラーメッセージ](https://support.smarthr.jp/ja/help/articles/8689194643481) +- [評価シート入力時のエラーメッセージ](https://support.smarthr.jp/ja/help/articles/8689194643481) \ No newline at end of file diff --git a/src/content/articles/products/contents/help-center/faq.mdx b/src/content/articles/products/contents/help-center/faq.mdx index ceaa5e0ee..66909b8f5 100644 --- a/src/content/articles/products/contents/help-center/faq.mdx +++ b/src/content/articles/products/contents/help-center/faq.mdx @@ -3,26 +3,29 @@ title: 'よくある質問の書き方' description: 'SmartHRヘルプセンターに掲載するヘルプページのライティングの考え方とパターンをまとめています。' order: 7 --- - ## よくある質問の種類 +{} よくある質問は、以下のパターンで作成します。 -* [単一の質問に答える](#h2-1) -* [いくつかの質問をまとめる](#h2-2) +* [単一の質問に答える](#answer-single-question) +* [いくつかの質問をまとめる](#answer-multiple-questions) +{} ## 単一の質問に答える記事の構成 「よくある質問」の基本形。基本的にはこの形式で作成します。 -1. [質問（タイトル）](#h3-0) -2. [回答（見出し）](#h3-1) -3. [説明](#h3-2) -4. [関連リンク](#h3-3) -5. [操作手順](#h3-4) +1. [質問（タイトル）](#question-title) +2. [回答（見出し）](#answer-heading) +3. [説明](#explanation) +4. [関連リンク](#related-links) +5. [操作手順](#operation-steps) +{} ### 1.質問（タイトル） 文頭に `Q. ` をつけ、ユーザーからの質問のように **「XXできる？」「XXするには？」** という形（常体）で記載します。 文末が「？」で終わらない場合は、[Headingの見出しの書き方](../../../../products/components/heading/#h2-3)に則り、句点は省略します。 例外的に口語体で表現しますが、`「　」`は使用しません。 +{} ### 2.回答（見出し） 文頭に`A. `をつけ、質問に対する回答を端的にまとめます。 @@ -30,31 +33,35 @@ order: 7 例外的に口語体で表現しますが、`「　」`は使用しません。 [Headingの見出しの書き方](../../../../products/components/heading/#h2-3)に則り、句点は省略します。 +{} ### 3.説明 質問に対して、回答を詳細に説明します。 本文のスタイルを適用します。 +{} ### 4.関連リンク ヘルプセンターの中に操作手順などの詳細ページがある場合（同内容のページがヘルプセンター内に複数あると、管理が煩雑になり、最新の情報に保ちにくいため）や、他のWebサイトに参照記事がある場合はリンクを設置します。 関連コンテンツのスタイルを適用します。 +{} ### 5.操作手順 参照先のヘルプページがないときは、記事中に手順を書きます。 手順が複数の工程に分かれる場合は、見出しで工程ごとに分割し、操作手順記事と同じルールで記載します。 見出し2と本文のスタイルを適用します。 +{} ### ライティングパターン 質問と回答のライティングパターンをまとめました。 内容に応じて、文末の表現などをアレンジしても構いません。 -| コンテキスト | 1.質問（タイトル） | 2.回答（見出し1） | -| :--- | :--- | :--- | -| こういうことはできるのか？ | Q. XXXできる？ | A. はい、XXXXできます／A. いいえ、XXXXXはできません | -| メイン操作ではないイレギュラーな操作 | Q. XXXするには？ |A. XXXXXを設定します | -| 仕様の背景の説明 | Q. XXXはなぜ？ | A. XXXXXためです | +| コンテキスト | 1.質問（タイトル） | 2.回答（見出し1） | +| :-------------------------- | :--------------------- | :------------------------------------ | +| こういうことはできるのか？ | Q. XXXできる？ | A. はい、XXXXできます／A. いいえ、XXXXXはできません | +| メイン操作ではないイレギュラーな操作 | Q. XXXするには？ | A. XXXXXを設定します | +| 仕様の背景の説明 | Q. XXXはなぜ？ | A. XXXXXためです | #### 記載例 @@ -68,35 +75,40 @@ order: 7 * [Q. 給与・勤怠関連のレポートに含まれる「推移を示すグラフ」は、いつ時点の従業員情報を参照していますか？
A.［グループ化 行］に設定された時点（［対象期間（from）］、［対象期間（to）］、［支給日］）の従業員情報を参照しています](https://support.smarthr.jp/ja/help/articles/4412871737753) +{} ## いくつかの質問をまとめた記事の構成 1つの機能やテーマについて、よくある質問をまとめたいとき。（質問が増えてきたら個別の記事に分割することを検討しましょう。） 一問一答形式など、質問と回答の情報量が少ない場合にも使用して構いません。 -1. [タイトル](#h3-6) -2. [質問](#h3-7) -3. [回答](#h3-8) -4. [説明](#h3-9) +1. [タイトル](#title-for-faq-list) +2. [質問](#question-for-faq-list) +3. [回答](#answer-for-faq-list) +4. [説明](#explanation-for-faq-list) +{} ### 1.タイトル 質問の共通テーマを明記のうえ、「よくある質問」をタイトルに含めます。 - XXXXに関するよくある質問 - XXXX向けよくある質問 +{} ### 2.質問 単一の質問と対処方法を伝える場合のタイトルと同様。 見出し1のスタイルを適用します。 +{} ### 3.回答 単一の質問と対処方法を伝える場合の見出しと同様。 見出し2のスタイルを適用します。 +{} ### 4.説明 単一の質問、またはエラーの原因と対処方法を伝える場合の説明と同様。 本文のスタイルを適用します。 #### 記載例 -* [組織図・名簿に関するよくある質問](https://support.smarthr.jp/ja/help/articles/1500002013322) +* [組織図・名簿に関するよくある質問](https://support.smarthr.jp/ja/help/articles/1500002013322) \ No newline at end of file diff --git a/src/content/articles/products/contents/help-center/help-page.mdx b/src/content/articles/products/contents/help-center/help-page.mdx index 1a717976a..f086b1467 100644 --- a/src/content/articles/products/contents/help-center/help-page.mdx +++ b/src/content/articles/products/contents/help-center/help-page.mdx @@ -4,22 +4,28 @@ description: 'SmartHRヘルプセンターに掲載するヘルプページの order: 1 --- +{} ## ヘルプページの並び順 以下の観点で、ヘルプページの並び順を判断します。 +{} ### ユーザーがアプリケーションを操作する流れで並んでいるか ユーザーがアプリケーションを操作する流れを踏まえ、CRUD（Create、Read、Update、Delete）を意識して並び順を決めましょう。 +{} ### ユーザーに見てほしいページを優先して配置しているか はじめてアプリケーションを操作するユーザーに参照してほしいページなど、ユーザーに早く認知してほしいページがある場合は優先して配置します。 +{} ### 関連するページを近くに配置しているか 関連する情報が書かれているページ同士は近くに配置するようにします。 +{} #### 例 - [届出書類｜ヘルプセンター｜SmartHR](https://support.smarthr.jp/ja/help/sections/360008955494/) - [招待｜ヘルプセンター｜SmartHR](https://support.smarthr.jp/ja/help/sections/8c43d156-b95f-44d7-91d0-47a102062ec0/) +{} ## ヘルプページの構成要素 ヘルプページは、以下の要素で構成します。それぞれの要素が、ユーザーに情報を伝えるために担っている役割を説明します。 @@ -30,15 +36,18 @@ order: 1 - 画像 - 囲み +{} ### タイトル どんな内容が書かれているかを想起できる表現をして、ユーザーが「読みたい情報がどこに書かれているか」を理解できるようにします。 ヘルプセンターを訪問したユーザーが、操作手順やトラブルシューティング、仕様の一覧を探していることを念頭において考えます。 インデックスに並んだときの一覧性を意識し、タイトルのライティングには規則性を持たせます。 +{} ### リード ユーザーがページの内容を理解するためのメンタルモデルを構築しやすいよう、このページで書かれている内容の全体感を説明します。 +{} ### 見出し 本文のアウトラインを把握できる表現をします。 見出しはページ全体の目次としても機能するので、「どんな内容」を「どういう順序」で「どれくらいの粒度」で書かれているかを把握する助けもします。 @@ -46,41 +55,47 @@ order: 1 ヘルプページの見出しは、見出し1〜5まであります。 本文で記載する内容を見出しを使って構造化します。ヘルプページの構成を考えるときには、まず見出しの設計をして、情報のボリューム、伝える単位を切り分けることからはじめると良いです。 +{} ### 本文 本文もなるべく簡潔に、一文一義「1つの文に1つの事柄を書く」ようにします。 ただし、ヘルプページで記載する内容は、ある条件下の挙動を説明するなど、情報が込み入っているケースも少なくありません。 情報を補う修飾節が必要な場合は、情報のチャンク（ぱっと見たときに"意味的な塊"を感じる単位）を意識して読点を使用しましょう。 +{} ### 画像 文章での説明が困難な場合には、概念図を作成したり、注釈を加えたスクリーンショットを併用します。 -詳しくは、[ヘルプセンターで使用する画像要素](../image/)を参照してください。 +詳しくは、[ヘルプセンターで使用する画像要素](/products/contents/help-center/image/)を参照してください。 +{} ### 囲み 本文で説明する主軸となる流れから、脱線する情報は囲みとして提供します。 ヘルプページでは、囲みに4つのスタイルを用意しています。 囲みの中身は本文を配置します。Tipsに限って、見出しを設置しても構いません。 +{} #### ヒント ページで説明している内容に加えて、知っておくとユーザーにメリットがある情報を紹介します。 ![hint.png](../images/hint.png) +{} #### 注意 注意を促したい場合に使います。 この情報を理解しないとユーザーが求めている情報を得られなかったり、意図しない結果に繋がったりする可能性のある、重要度の高い情報を記載します。 ![alert.png](../images/alert.png) +{} #### 関連コンテンツ ページで説明している内容に関連するリンクを紹介するときに使います。 ![related.png](../images/related.png) +{} #### 関連用語 用語ページで関連用語を紹介するときに使います。 -![words.png](../images/words.png) - +![words.png](../images/words.png) \ No newline at end of file diff --git a/src/content/articles/products/contents/help-center/image.mdx b/src/content/articles/products/contents/help-center/image.mdx index aae594ef3..373e7cfa0 100644 --- a/src/content/articles/products/contents/help-center/image.mdx +++ b/src/content/articles/products/contents/help-center/image.mdx @@ -6,6 +6,7 @@ order: 10 SmartHRヘルプセンターに掲載する画像に関する考え方をまとめています。 文章での説明が困難な場合には、概念図を作成したり、注釈を加えたスクリーンショットを併用したりします。 +{} ## スクリーンショット掲載の考え方 ### アクセシビリティの観点から、スクリーンショットはできるだけ使わず、テキストで説明する @@ -41,30 +42,31 @@ SmartHRヘルプセンターに掲載する画像に関する考え方をまと スクリーンショットを使う場合は、ユーザーに注目させたい部分を囲みまたは矢印で強調します。ボタンや画面内のエリアを強調する場合は、囲みで強調します。囲みを使うと見てほしい部分が読み取りづらくなる場合は、矢印で強調します。ただし、必要以上の強調はユーザーにとってノイズになってしまうため、囲みと矢印は同時に使わないようにしましょう。 -強調する箇所は、1つのスクリーンショットにつき、1部分を基本とします。複数の部分を流れで説明したい場合は、丸数字（①②③）で番号を振って、ユーザーに見てほしい順番をわかりやすくします。 +強調する箇所は、1つのスクリーンショットにつき、1部分を基本とします。複数の部分を流れで説明したい場合は、丸数字（①②③）で番号を振って、ユーザーに見てほしい順番をわかりやすくします。 アクセシビリティやメンテナンスの観点から、画像内にテキストを載せないようにしましょう。 -また、「[関連する情報は近くに配置する](../basic-rule/#h4-4)」にしたがって、スクリーンショットと対応する説明文を近くに配置すると、意図が伝わりやすくなります。 +また、「[関連する情報は近くに配置する](/products/contents/help-center/basic-rule/#place-relevant-information-nearby)」にしたがって、スクリーンショットと対応する説明文を近くに配置すると、意図が伝わりやすくなります。 ### スクリーンショットを使う場合は、ユーザーの操作に必要ない部分を取り除く スクリーンショットに写っているのがどの画面なのかを、ユーザーが判断しやすいようにしましょう。また、ユーザーの操作に必要ない部分は除いた範囲でスクリーンショットを撮ってください。 -操作の起点となる画面は、SmartHRのどの画面から操作するのかをユーザーが把握できるように、ヘッダーも含めたスクリーンショットを使いましょう。 +操作の起点となる画面は、SmartHRのどの画面から操作するのかをユーザーが把握できるように、ヘッダーも含めたスクリーンショットを使いましょう。 以降の画面は、ヘッダーを除いてトリミングすることを推奨します。どの画面から操作するのかは操作の起点で明示できているため、伝えなくても済む部分を取り除いて、ユーザーが次の操作に集中できるようにします。 +{} ## 本文と代替テキストのガイドライン 基本的な考え方は、アクセシビリティガイドラインの[画像の代替テキスト](https://smarthr.design/accessibility/alternative-text/)と同様です。 -画像を使用する際も、必要なことは本文テキストに記載し、画像はなくても伝わるようにします。 +画像を使用する際も、必要なことは本文テキストに記載し、画像はなくても伝わるようにします。 本文テキストとの重複を避けるため、代替テキストには「何のスクリーンショットなのか」「何を説明する図なのか」を端的に記載します。 以下に、画像の種類ごとの例を示します。 ### SmartHRの画面 -SmartHRの画面のスクリーンショットで操作の位置を示す場合は下記のように書きます。 +SmartHRの画面のスクリーンショットで操作の位置を示す場合は下記のように書きます。 画像内で囲みをつけている箇所は本文中に記載しているため、代替テキストには含めません。 本文：部署画面で［部署を追加］を押します。 @@ -77,12 +79,12 @@ SmartHRの画面のスクリーンショットで操作の位置を示す場合 ### 概念図 -機能の概念を説明する際などに使う図の代替テキストは、図で何を説明しているのかを代替テキストに書きます。 +機能の概念を説明する際などに使う図の代替テキストは、図で何を説明しているのかを代替テキストに書きます。 図で説明している内容は、基本的に本文にも記載します。 -本文：履歴を追加すると、部署の階層が最大値の10階層を超える場合に発生するエラーです。 -例えば、下記のイメージのようなケースがあります。「階層1」は「部署9」まで、8つの下位部署を持っています。「管理部」は「総務課」を下位部署に持っています。 -「管理部」の履歴を更新し、「階層9」を上位部署に設定した場合、「管理部」の下位部署である「総務課」の履歴も更新されます。 +本文：履歴を追加すると、部署の階層が最大値の10階層を超える場合に発生するエラーです。 +例えば、下記のイメージのようなケースがあります。「階層1」は「部署9」まで、8つの下位部署を持っています。「管理部」は「総務課」を下位部署に持っています。 +「管理部」の履歴を更新し、「階層9」を上位部署に設定した場合、「管理部」の下位部署である「総務課」の履歴も更新されます。 その結果、総務課の階層が11階層目となり、10階層を超えてしまうため、エラーとなります。 代替テキスト：エラーが発生する状況を説明する図 @@ -95,7 +97,7 @@ SmartHRの画面のスクリーンショットで操作の位置を示す場合 図で伝えたい内容の要約を代替テキストに書きます。 -本文： +本文： 例えば、下記のように設定した場合は、部署1が［営業本部］かつ役職が［マネージャー］のBさんのみが承認者となります。 * ［承認者の部署］：［部署を指定］>［営業本部］ @@ -103,21 +105,21 @@ SmartHRの画面のスクリーンショットで操作の位置を示す場合 代替テキスト：経路の設定画面で承認者を部署と役職で指定した画面のスクリーンショット。その下には3人の登場人物を例に、本文の内容を説明するイラストがある。 -画像： +画像： ![経路の設定画面で承認者を部署と役職で指定した画面のスクリーンショット。その下には3人の登場人物を例に、本文の内容を説明するイラストがある。](../images/conceptual-diagram-sample-2.png) ### 書類 SmartHRの画面と同じく、画像で表している内容を本文中に記載します。 -本文： -一般の生命保険 -証明書の内容を確認して、適用制度や申告額などを入力します。 -- ［保険料種別］で［一般の生命保険］を選択 -- 証明書の「適用制度」を確認し、画面で［区分］を選択 +本文： +一般の生命保険 +証明書の内容を確認して、適用制度や申告額などを入力します。 +- ［保険料種別］で［一般の生命保険］を選択 +- 証明書の「適用制度」を確認し、画面で［区分］を選択 - 証明書の「一般申告額」を確認し、画面の［申告額］に金額を入力 代替テキスト：SmartHRの画面と保険料控除証明書の対応を表す図 -画像： -![SmartHRの画面と保険料控除証明書の対応を表す図](../images/document-sample.png) +画像： +![SmartHRの画面と保険料控除証明書の対応を表す図](../images/document-sample.png) \ No newline at end of file diff --git a/src/content/articles/products/contents/help-center/index.mdx b/src/content/articles/products/contents/help-center/index.mdx index d187ec3e9..bb68127ef 100644 --- a/src/content/articles/products/contents/help-center/index.mdx +++ b/src/content/articles/products/contents/help-center/index.mdx @@ -9,55 +9,71 @@ order: 5 ヘルプページのライティングは、基本的にプロダクトデザインにおける[基本的な考え方](../writing-style/)、[用字用語](../idiomatic-usage/)、[UIテキスト](../ui-text/)に準拠しますが、ユーザーのメンタルモデルに配慮して特例を設けているケースがあります。 詳しくは、ヘルプページのライティングパターンなどを参照してください。 +{} ## ヘルプページ作成の基本的な考え方 ユーザーの関心事は何かを念頭に、どこまで説明が必要か、どう見せると伝わるかを考えます。 多すぎる情報はノイズになるので、取捨選択し、ページを設計します。 -* [ヘルプページの構成](../help-center/help-page/) -* [ヘルプページの書き方](../help-center/basic-rule/) +* [ヘルプページの構成](/products/contents/help-center/help-page/) +* [ヘルプページの書き方](/products/contents/help-center/basic-rule/) + +{} ## ヘルプページのタイプ ヘルプページを情報の種類ごとに、下記のタイプに分類します。 +{} ### 1. 機能概要 -* 「この機能とはどういったものであるか」を説明したもの。ユーザーがアプリケーションを使いこなすうえで理解しておきたい、機能の定義や設計思想を伝えます。 -* ドメイン知識を理解し、開発時に想定したユースケースとユーザーのメンタルモデルを橋渡しすることを考えます。 +* 「この機能とはどういったものであるか」を説明したもの。ユーザーがアプリケーションを使いこなすうえで理解しておきたい、機能の定義や設計思想を伝えます。 +* ドメイン知識を理解し、開発時に想定したユースケースとユーザーのメンタルモデルを橋渡しすることを考えます。 * ヘルプページのなかでは、もっとも書くのが難しいタイプのページです。 +{} #### どのように読まれるか 機能の概要（全体感）、機能を使用するユーザーメリットを理解できる。 +{} #### どうやって伝えるか -* [概要の書き方](../help-center/overview/) +* [概要の書き方](/products/contents/help-center/overview/) +{} ### 2. 操作手順 * 機能の操作を順序立てて説明したもの。 +{} #### どのように読まれるか ユーザーが達成したい操作について、手順や注意点を確認できる。 +{} #### どうやって伝えるか -* [操作手順の書き方](../help-center/step-by-step/) +* [操作手順の書き方](/products/contents/help-center/step-by-step/) +{} ### 3. 仕様の一覧 * 設定項目や、一定条件における制限など、仕様を網羅的にまとめたもの。 +{} #### どのように読まれるか ページを通して読まずとも、目当ての仕様をピンポイントで確認できる。 +{} ### 4. トラブルシューティング・FAQ * 操作時に起こったトラブルの解決やエラーメッセージの意味、仕様に関する質問など、個別の疑問を解消する情報を伝えます。SmartHRヘルプセンターでは「よくある質問」と呼んでいます。 +{} #### どのように読まれるか 特定の疑問やエラーを解消できる。 +{} #### どうやって伝えるか -* [エラーメッセージごとの対応方法の書き方](../help-center/error-handling/) -* [よくある質問の書き方](../help-center/faq/) +* [エラーメッセージごとの対応方法の書き方](/products/contents/help-center/error-handling/) +* [よくある質問の書き方](/products/contents/help-center/faq/) +{} ### 5. 用語 * アプリケーション内で使用している用語の定義を説明します。 * 2022年1月時点では、人事評価機能でのみ掲載しています。 +{} ## フィードバック先 気になることがあったときには、気軽にUXライターに声をかけてください。 -また、記載内容に関する質問や依頼は、社内Slack`#design_system相談`チャンネルにワークフローも用意しています。こちらも利用してみてください。 +また、記載内容に関する質問や依頼は、社内Slack`#design_system相談`チャンネルにワークフローも用意しています。こちらも利用してみてください。 \ No newline at end of file diff --git a/src/content/articles/products/contents/help-center/overview.mdx b/src/content/articles/products/contents/help-center/overview.mdx index efd85650b..623058f7f 100644 --- a/src/content/articles/products/contents/help-center/overview.mdx +++ b/src/content/articles/products/contents/help-center/overview.mdx @@ -10,7 +10,7 @@ order: 3 ## 作成基準 -[操作手順](../step-by-step/)の1セクション分の文章量では概要を伝えきれない場合に、概要に関するヘルプページを作成します。 +[操作手順](/products/contents/help-center/step-by-step/)の1セクション分の文章量では概要を伝えきれない場合に、概要に関するヘルプページを作成します。 ## 構成 diff --git a/src/content/articles/products/contents/help-center/reference.mdx b/src/content/articles/products/contents/help-center/reference.mdx index e90879235..8d05c049a 100644 --- a/src/content/articles/products/contents/help-center/reference.mdx +++ b/src/content/articles/products/contents/help-center/reference.mdx @@ -44,7 +44,7 @@ order: 5 |B|◯|◯|✗| |C|✗|◯|✗| -表を使うときは[見やすくメンテナンスしやすい形式](../basic-rule/#h4-6)で書きましょう。 +表を使うときは[見やすくメンテナンスしやすい形式](/products/contents/help-center/basic-rule/#use-table-with-readable-and-maintainable-format)で書きましょう。 ### 平文が適している場合 diff --git a/src/content/articles/products/contents/help-center/review.mdx b/src/content/articles/products/contents/help-center/review.mdx index d96f7f655..618d19151 100644 --- a/src/content/articles/products/contents/help-center/review.mdx +++ b/src/content/articles/products/contents/help-center/review.mdx @@ -20,7 +20,7 @@ order: 11 | 5 | （依頼されて作成したヘルプページの場合）依頼者の課題を解決できているか | 仕様の変更や、ヘルプページで解決したいことが反映されているか。 | | 6 | 画像の表示内容が適切か | 個人情報や開発環境の内容など、不適切な内容が残っていないか。 | | 7 | 記載内容は正しいか | 画像内とテキストで文言が一致しているか。プロダクトの表記・動作と異なる点はないか。 | -| 8 | 画像名や画像のaltは適切か | 不適切な画像名になっていないか、altが空になっていないかなど。参考：[本文と代替テキストのガイドライン](../image/#h2-1) | +| 8 | 画像名や画像のaltは適切か | 不適切な画像名になっていないか、altが空になっていないかなど。参考：[本文と代替テキストのガイドライン](/products/contents/help-center/image/#body-and-alt-text-guidelines) | ## レビュー レビューは、第三者が確認し、品質を担保するために実施します。 diff --git a/src/content/articles/products/contents/help-center/step-by-step.mdx b/src/content/articles/products/contents/help-center/step-by-step.mdx index d267da9b1..397d890d1 100644 --- a/src/content/articles/products/contents/help-center/step-by-step.mdx +++ b/src/content/articles/products/contents/help-center/step-by-step.mdx @@ -4,10 +4,12 @@ description: 'SmartHRヘルプセンターに掲載するヘルプページの order: 4 --- +{} ## 基本的な考え方 -操作手順に関するヘルプページでは、ユーザーがやりたいこと（ゴール）を達成するために、アプリケーションをどのように操作すれば良いのかを説明します。 +操作手順に関するヘルプページでは、ユーザーがやりたいこと（ゴール）を達成するために、アプリケーションをどのように操作すれば良いのかを説明します。 ユーザーが順を追って操作を把握し、ゴールを達成できることを重視してください。 +{} ## 構成 操作手順に関するヘルプページは、以下のセクションを組み合わせて構成します。 @@ -22,22 +24,25 @@ order: 4 | 7 | 囲み | Tips | × | | 8 | 見出し＋本文 | 操作全体に関わる補足事項 | × | +{} ## セクションごとの書き方 -各セクションの内容をどのように伝えるかをまとめています。 +{} ### 1. ユーザーがやりたいこと（タイトル） この操作手順を踏むと、最終的に何が実現できるのかを記載しましょう。 ユーザーが何をしたいのかを念頭に、端的に **「XXをXXする」** という形で記載します。 +{} ### 2. ユーザーがやりたいことをアプリケーション上の言葉で言い直す（リード文） タイトルだけで不十分な場合は、このページで何の手順を説明するのかを記載しましょう。 1〜2文を目安として「**XXについて説明します。**」という形で記載します。「このページでは〜」という導入は不要です。 -1〜2文に収まらない場合は、[説明事項](#h3-2)や[補足事項](#h3-7)のセクションを設けることを検討してください。 +1〜2文に収まらない場合は、[説明事項](#explanatory-items)や[補足事項](#additional-information)のセクションを設けることを検討してください。 原則として、スクロールしなくても目次が見える状態を意識します。長文、画像、囲みの多用によって、目次が埋もれないようにしてください。 +{} ### 3. 操作に先立つ説明事項（見出し＋本文） 事前に準備をしたり、特定の情報を把握したりしないと、操作が進まない懸念がある場合は、準備事項や注意点を記載しましょう。 @@ -45,59 +50,65 @@ order: 4 リード文に統合できる場合や、内容が自明な場合は不要です。 +{} ### 4. 操作手順の要約（見出し） 各ステップで何をするのかを端的に記載しましょう。 文頭に番号（例：1.）をつけて、H2のスタイルを適用します。ユーザーが「どの画面で何をするのか」を端的に記載し、見出しだけ読んでも操作が完結するように書きます。 +{} ### 5. 操作手順の詳細（本文） 見出しとして書いた要約を補う形で、各ステップで何をするのかを詳細に記載しましょう。 ユーザーが「どの画面で何をするのか」と「その結果、何が起きるのか」をあわせて説明します。 -原則として、ユーザーの操作は能動態（XXします）で記載します。 - -ユーザーの操作で起きる結果はシステムの挙動であり、ユーザーからすると「システムからXXされた」という関係のため、受動態（XXされます）で記載します。 +- 原則として、ユーザーの操作は**能動態（XXします）**で記載します。 +- ユーザーの操作で起きる結果はシステムの挙動であり、ユーザーからすると「システムからXXされた」という関係のため、**受動態（XXされます）**で記載します。 最後のステップでは、ユーザーが正しく操作を完了したことを確認できる方法を記載します。（例：XX画面でXXが最新の情報に更新されたことを確認します。） また、このステップ固有の注意事項やTipsがある場合は、本文の最後に記載します。 +{} ### 6. 注意点（囲み） -注意喚起しないと、ユーザーが操作を進められなくなったり、データを損失したりしてしまう場合に記載しましょう。 - +注意喚起しないと、ユーザーが操作を進められなくなったり、データを損失したりしてしまう場合に記載しましょう。 [囲みのガイドライン](https://smarthr.design/products/contents/help-center/help-page/#h3-8)を参照してください。 + +{} ### 7. Tips（囲み） この手順に関連する内容で、ユーザーに役立つ情報を記載しましょう。 Tipsとして扱うのは、ユーザーが読み飛ばしても、操作を完了できる内容です。読み飛ばしてはいけない内容は、注意点として記載してください。 また、本来の目的である操作手順の説明を妨げないよう、ユーザーにとって本当に必要な内容だけを厳選して記載してください。 -[囲みのガイドライン](https://smarthr.design/products/contents/help-center/help-page/#h3-8)を参照してください。 +[囲みのガイドライン](/products/contents/help-center/help-page/#frames)を参照してください。 +{} ### 8. 操作全体に関わる補足事項（見出し＋本文） -特定のステップではなく、操作全体に関わる補足事項や注意点がある場合に記載しましょう。 - -必要に応じて見出しを立てて、セクションとしてまとめます。 - -操作の前に確認が必要な情報は、[説明事項](#h3-2)への移動を検討してください。 +特定のステップではなく、操作全体に関わる補足事項や注意点がある場合に記載しましょう。 +必要に応じて見出しを立てて、セクションとしてまとめます。 +操作の前に確認が必要な情報は、[説明事項](#explanatory-items)への移動を検討してください。 +{} ## 複数の操作について説明する場合 「権限の追加」「権限の編集」「権限の削除」など、複数の操作を1ページにまとめる場合は、個別の操作でユーザーがやりたいことをH2、操作手順の要約をH3として記載します。 情報量が増えてきたら、個別の記事に分割することを検討しましょう。 +{} ## 具体的な書き方のヒント -* まずユーザーの目的を明確にし、そこにたどり着くまでに必要なアクションを箇条書きで書き出しましょう。 -* アクションは「どの画面で何をする」という単位で切り分けます。 -* 目的を達成するために必須のアクションを操作手順とし、その他のアクションや補足情報と区別してください。 -* 事前に把握すべき情報や準備することがあれば、別途メモしましょう。 -* 操作手順を説明するページでは、ユーザーが順を追って操作を把握できることが重要です。Tipsなど注意を逸らす情報を安易に追加しないようにしましょう。Tipsや注意事項が複数ある場合は、囲みを外して本文に統合するか、複数の囲みを統合することを検討してください。 +- まずユーザーの目的を明確にし、そこにたどり着くまでに必要なアクションを箇条書きで書き出しましょう。 +- アクションは「どの画面で何をする」という単位で切り分けます。 +- 目的を達成するために必須のアクションを操作手順とし、その他のアクションや補足情報と区別してください。 +- 事前に把握すべき情報や準備することがあれば、別途メモしましょう。 +- 操作手順を説明するページでは、ユーザーが順を追って操作を把握できることが重要です。Tipsなど注意を逸らす情報を安易に追加しないようにしましょう。Tipsや注意事項が複数ある場合は、囲みを外して本文に統合するか、複数の囲みを統合することを検討してください。 +{} ## ライティングパターン -操作手順のライティングパターンをまとめました。 +操作手順のライティングパターンをまとめました。 内容に応じて、表現をアレンジしても構いません。 +{} ### 単一の操作のライティングパターン | # | 内容 | 例1 | 例2 | @@ -110,6 +121,7 @@ Tipsとして扱うのは、ユーザーが読み飛ばしても、操作を完 #### 記載例 [組織図または名簿形式のCSVファイルをダウンロードする](https://support.smarthr.jp/ja/help/articles/4411586712985) +{} ### 複数の操作のライティングパターン | # | 内容 | 例 | @@ -121,4 +133,4 @@ Tipsとして扱うのは、ユーザーが読み飛ばしても、操作を完 | 5 | 操作手順の詳細（本文） | XX画面で［XX］を押すと、XXされます。 | #### 記載例 -[評価テンプレートを管理する](https://support.smarthr.jp/ja/help/articles/4407070408473) +[評価テンプレートを管理する](https://support.smarthr.jp/ja/help/articles/4407070408473) \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/action.mdx b/src/content/articles/products/contents/idiomatic-usage/action.mdx index 3f15712bc..137da1bf2 100644 --- a/src/content/articles/products/contents/idiomatic-usage/action.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/action.mdx @@ -6,6 +6,8 @@ ignoreH3Nav: true --- 操作を表す用語を定義します。 {/* textlint-disable */} + +{} ## 「つくる」操作を表す文言 ### 説明 @@ -23,6 +25,7 @@ ignoreH3Nav: true 「追加」を使うと違和感がある場合は、社内Slack`#design_system_相談`で気軽に相談してください。 +{} ## 操作を止めるときの言葉（キャンセル・取り消し・中断の考え方） ### 説明 @@ -41,6 +44,7 @@ ignoreH3Nav: true - 中断とは、実行中の操作を止めること - 例：アンケートの回答を中断して、一時保存する +{} ## 状態を戻すときの言葉（解除・差し戻し・戻すの考え方） ### 説明 @@ -59,6 +63,7 @@ ignoreH3Nav: true - 戻すとは、業務フローのなかでタスクを前の状態に戻すこと - 例：未確定に戻す +{} ## ファイルを取り込んで操作するときの文言 ### 説明 @@ -76,9 +81,10 @@ ignoreH3Nav: true - CSVを取り込む ### 関連ルール -[ボタンラベルには動詞の終止形を使用する](/products/contents/ui-text/app-writing/#h2-1) -[画面タイトルや項目名には名詞を使用する](/products/contents/ui-text/app-writing/#h2-2) +[ボタンラベルには動詞の終止形を使用する](/products/contents/ui-text/app-writing/#use-finite-verbs-in-button-labels) +[画面タイトルや項目名には名詞を使用する](/products/contents/ui-text/app-writing/#use-nouns-in-screen-titles-and-field-names) +{} ## バックグラウンド処理をリクエスト時の文言は「\{処理名\}を受け付けました」 ### 説明 @@ -96,6 +102,7 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1608001964454300 給与明細でCSV取り込み後のインフォメーションパネルの文言として、予約→受け付けに変更。 +{} ## 「取り込み」と表記し、「インポート」の使用は控える ### 説明 SmartHRにデータを適用する操作は「取り込み」と表記します。 @@ -103,14 +110,16 @@ SmartHRにデータを適用する操作は「取り込み」と表記します ### 議事録 https://smarthr-inc.docbase.io/posts/1650767 +{} ## 「アップロード」と「ダウンロード」を使用する ### 説明 -SmartHRにファイルを転送する操作は「アップロード」と表記します。 +SmartHRにファイルを転送する操作は「アップロード」と表記します。 SmartHRからファイルを入手する（ストレージにあるデータをそのまま落としてくる）操作は「ダウンロード」と表記します。 ### 議事録 https://smarthr-inc.docbase.io/posts/1650767 +{} ## 「移動」と表記し、「遷移」の使用は控える ### 説明 「遷移」よりも「移動」の方が、ユーザーにとって馴染みがあると判断しました。 @@ -118,6 +127,7 @@ https://smarthr-inc.docbase.io/posts/1650767 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1603697989037600 +{} ## アプリケーション上でボタンを押下する操作は「押す」と表記し、「クリック」「タップ」の使用は控える ### 説明 @@ -126,25 +136,28 @@ PCでもスマートフォンでも違和感のない言葉として、「押す ### 議事録 https://smarthr-inc.docbase.io/posts/1726802 +{} ## 「書き出し」と表記し、「エクスポート」の使用は控える ### 説明 -SmartHRからデータを抽出する操作は「書き出し」と表記し、「エクスポート」「出力」という表記は使いません。 +SmartHRからデータを抽出する操作は「書き出し」と表記し、「エクスポート」「出力」という表記は使いません。 ただし、ヘルプページなどで、Excelなど別のソフトウェア使う操作でUIに「エクスポート」と書かれている場合には、ソフトウェア上の表記として用いて構いません。 ### 議事録 https://smarthr-inc.docbase.io/posts/1650767 +{} ## 「再読み込み」と表記し、「更新」「リロード」の使用は控える ### 説明 -画面を最新の状態にする操作は、「再読み込み」と表記します。 -SmartHRでは、従業員情報などを編集して保存することを「更新」と表記しているので、混同を避けるために「再読み込み」としました。 +画面を最新の状態にする操作は、「再読み込み」と表記します。 +SmartHRでは、従業員情報などを編集して保存することを「更新」と表記しているので、混同を避けるために「再読み込み」としました。 なお、特別な理由がない限りは「画面を再読み込み」と表記し、「ブラウザを再読み込み」「ページを再読み込み」は使いません。 ### 議事録 -https://kufuinc.slack.com/archives/CJX59GJFR/p1640048227260600 +https://kufuinc.slack.com/archives/CJX59GJFR/p1640048227260600 https://smarthr-inc.docbase.io/posts/2222090#%E8%AD%B0%E8%AB%96-1 +{} ## アプリケーションが主語のときは「使用」と表記し、「利用」の使用は控える ### 説明 @@ -154,7 +167,7 @@ https://smarthr-inc.docbase.io/posts/2222090#%E8%AD%B0%E8%AB%96-1 組織図・名簿機能は、SmartHR基本機能の部署・従業員情報を使用して、組織図・名簿を作成できる機能です。 ### 例外 -ユーザーが主語の場合は、コンテキストによって「使用」と「利用」を使い分けます。 +ユーザーが主語の場合は、コンテキストによって「使用」と「利用」を使い分けます。 基本的には「使用」と表記し、「役立つように上手く使う」ニュアンスを出したい場合は「利用」と表記します。 #### 「使用」を使う例 @@ -169,16 +182,19 @@ https://smarthr-inc.docbase.io/posts/2222090#%E8%AD%B0%E8%AB%96-1 - https://kufuinc.slack.com/archives/CJX59GJFR/p1638842362239100 - https://kufuinc.slack.com/archives/C01L7GK9APK/p1733727109202639 +{} ## ヘルプページなどのリファレンスの閲覧を促す場合は「参照」と表記し、「確認」の使用は控える ### 説明 アプリケーション上での「確認」を求める場合と明確に書き分けるため、「参照」としました。 +{} ## アプリケーション上でテキストリンクを押下する操作は「開く」と表記し、「クリック」「タップ」の使用は控える ### 説明 ボタンに関しては「押す」を採用しますが、英文ドキュメントにおいて"open the link" すると書かれている点からも、リンクは「開く」を採用します。 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1667907876477849 +{} ## 「複製」と表記し、「コピー」の使用は控える ### 説明 「コピー」は情報をテンポラリ領域に保持することを表し、「複製」はコピーした情報を別のデータとして作成まですることを表すため、「複製」が適切だと判断しました。 @@ -187,18 +203,22 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1667907876477849 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1588576567030800 +{} ## 「言語選択」と表記する ### 説明 言語切替・言語切り替え・ 言語切替え・言語切換・言語切り換え・言語切換えなどの言い回しは避けます。 +{} ## 「コピーアンドペースト」と表記し、「コピー＆ペースト」の使用は控える ### 説明 「コピー＆ペースト」、「コピー・ペースト」、「コピペ」といった表記の使用は控えます。 +{} ## ラジオボタンの項目を選ぶ操作は「選択する」と表記する ### 説明 ラジオボタンで任意の項目を選ぶ操作は、「ラジオボタンを選択する」と表記します。 +{} ## チェックボックスの操作は「チェックを入れる/外す」と表記する ### 説明 チェックボックスの操作は「チェックを入れる/外す」と表記します。 @@ -206,20 +226,22 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1588576567030800 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1671096565102229 +{} ## 「ドラッグアンドドロップ」と表記し、「ドラッグ＆ドロップ」や「ドラッグ・ドロップ」の使用は控える ### 説明 「ドラッグ＆ドロップ」や「ドラッグ・ドロップ」といった表記の使用は控えます。 +{} ## 「並べ替え」と表記する ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1608192112482000?thread_ts=1608095863.462900&cid=CJX59GJFR +{} ## ZIPファイルの「展開」と表記し、「解凍」または「開く」の使用は控える ### 説明 ZIPファイルに含まれるファイルを取り出すときのアクションは「展開」と表記します。 「開く」は、特にWindowsの場合、「展開」とは動作が異なる可能性があるため、使用は控えます。 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1731573095610129 -{/* textlint-enable */} - +{/* textlint-enable */} \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/component.mdx b/src/content/articles/products/contents/idiomatic-usage/component.mdx index a2393a753..502abc823 100644 --- a/src/content/articles/products/contents/idiomatic-usage/component.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/component.mdx @@ -6,25 +6,21 @@ ignoreH3Nav: true --- コンポーネントの呼び方を定義します。 {/* textlint-disable */} - +{} ## 「ドロップダウンリスト」と表記し、「プルダウンメニュー」などの使用は控える - ### 説明 - UIコンポーネントのDropdownやSelectのような、クリックで展開するリストは「ドロップダウンリスト」と表記します。 理由は以下の通りです。 - -- 「プルダウン」よりも「ドロップダウン」の方が検索のヒット数で優勢 -- 操作メニューだけに使用されるとは限らない（項目の一覧から選択させる場合にも使用する）ため、「メニュー」より「リスト」が適切 +「プルダウン」よりも「ドロップダウン」の方が検索のヒット数で優勢 +操作メニューだけに使用されるとは限らない（項目の一覧から選択させる場合にも使用する）ため、「メニュー」より「リスト」が適切 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1649397466415699 - +{} ## アプリケーションの操作画面は「画面」で表記する ### 説明 - アプリケーションの操作画面は「画面」と表記します。「ウィンドウ」、「ダイアログ」、「モーダル」という表記は使いません。 ユーザーの関心は、画面で「何ができるか」です。その画面が「ダイアログなのか？ウィンドウなのか？」といったUIの書き分けは、ユーザーの使い勝手に影響しないと判断しました。 UI上のテキストやヘルプページでは、画面のタイトルを明示して、何ができるかを案内してください。 @@ -32,19 +28,17 @@ UI上のテキストやヘルプページでは、画面のタイトルを明示 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1649969573941349 +{} ## 「検索フォーム」と表記し、「検索ボックス」の使用は控える - ### 説明 - 検索したいキーワードを入力するInputは「検索フォーム」と表記します。 ComboBoxを使用する場合も含めて、「検索フォーム」と呼びます。 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1688098238593719 +{} ## 「アイコン」と表記し、「マーク」の使用は控える - ### 説明 - アプリケーション上で使用されているアイコンは、「鉛筆アイコン」「紙飛行機アイコン」など「◯◯アイコン」という形式で表記します。 -別のものを指している印象を与えかねないため、「マーク」は使いません。 +別のものを指している印象を与えかねないため、「マーク」は使いません。 \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/count.mdx b/src/content/articles/products/contents/idiomatic-usage/count.mdx index f81a644ba..7164670e3 100644 --- a/src/content/articles/products/contents/idiomatic-usage/count.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/count.mdx @@ -6,39 +6,43 @@ ignoreH3Nav: true --- 数字の表記や日時・人数といった数えの表記を定義します。 +{} ## 数字は半角の算用数字で表記する ### 説明 -「1つ・2つ」「1回・2回」と数えられるものは算用数字で表記します。 +「1つ・2つ」「1回・2回」と数えられるものは算用数字で表記します。 丸数字については「丸数字（数字を丸で囲っているもの）の使用は控える」を参照してください。 ### 例 -OK： 本人確認書類1点 +OK： 本人確認書類1点 NG： 本人確認書類一点 ### 例外 -固有名詞や慣用句は例外です。「単一」、「一部」、「一語一句」や「一を聞いて十を知る」など、熟語やことわざは漢数字を用います。 -漢数字か算用数字か確認する際は、数字部分を別の数字に変えてみてください。 +固有名詞や慣用句は例外です。「単一」、「一部」、「一語一句」や「一を聞いて十を知る」など、熟語やことわざは漢数字を用います。 +漢数字か算用数字か確認する際は、数字部分を別の数字に変えてみてください。 確認例： 一語一句→二語三句（変えると不自然なため、漢数字のままが正しい） ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1629940901001400 +{} ## 丸数字（数字を丸で囲っているもの）の使用は控える ### 説明 環境依存文字のため、丸数字は使用せず、算用数字を使用します。 ### 例外 -書類上で使われている丸数字をアプリケーション上でも示したい場合のみ、丸数字を使用できます。 -この場合は、含まれる文字数が多く、可読性も高いUnicodeを推奨します。 -ただし、NG例の通り、文字サイズが小さいものや、黒丸、二重丸は使いません。 +書類上で使われている丸数字をアプリケーション上でも示したい場合のみ、丸数字を使用できます。 +この場合は、含まれる文字数が多く、可読性も高いUnicodeを推奨します。 +ただし、NG例の通り、文字サイズが小さいものや、黒丸、二重丸は使いません。 + {/* textlint-disable */} ### 例 -OK： ⓪（U+24EA）、①（U+2460）〜⑳（U+2473）、㉑（U+3251）〜㊿（U+32BF） +OK： ⓪（U+24EA）、①（U+2460）〜⑳（U+2473）、㉑（U+3251）〜㊿（U+32BF） NG： ➀〜➉（U+2780〜U+2789）、❶（U+2776）、⓵（U+24F5） {/* textlint-enable */} ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1648186028804249 +{} ## 従業員に関連する数え方の表記 ### 説明 @@ -58,11 +62,12 @@ NG：37人の従業員情報を書き出しました。 OK：22件の社員番号アカウントを表示中 NG：22名の社員番号アカウントを表示中 +{} ## 日付は「YYYY/MM/DD」、時刻は「hh:mm:ss」と表記し、期間を表す記号は「〜」を使用する ### 説明 -他社のアプリケーションと連携しやすいように、日付（date）の文字列形式は、YYYY/MM/DDで表記します。日付の要素は/で区切ります。 -YYYY：西暦年4桁 -MM：2桁の月 +他社のアプリケーションと連携しやすいように、日付（date）の文字列形式は、YYYY/MM/DDで表記します。日付の要素は/で区切ります。 +YYYY：西暦年4桁 +MM：2桁の月 DD：2桁の日 時刻（time）の文字列形式は、hh:mm:ssで表記します。状況に応じて、ssは省略しても構いません。 @@ -70,25 +75,34 @@ hh：24時間制の2桁の時 mm：2桁の分 ss：2桁の秒 +時刻（time）の文字列形式は、hh:mm:ssで表記します。状況に応じて、ssは省略しても構いません。 +hh：24時間制の2桁の時 +mm：2桁の分 +ss：2桁の秒 + また、期間を表す場合には、〜（波線）を使います。 ### 例 -OK： 2022/01/01、23:00:05、2022/01/01〜2022/03/01 +OK： 2022/01/01、23:00:05、2022/01/01〜2022/03/01 NG： 2022/1/1、PM11:00:05、2022/01/01 - 2022/03/01、2022/01/01−2022/03/01 + なお、プロダクトの値としての日時ではない場合は「2019年1月1日」「15時35分」と表記しても構いません。 +{} ## ファイルサイズは英字2文字で表記する ### 説明 数字と単位の間にはスペースを入れず、「5GB」のように表記します。 ### 例外 byte単独で使う場合のみ、例外的にカタカナで表記します。 + {/* textlint-disable */} ### 例 -OK： 5GB、10TB、2バイト +OK： 5GB、10TB、2バイト NG： 5 GB、10テラバイト、2byte {/* textlint-enable */} +{} ## 「か所」「か月」と表記する ### 説明 日本語スタイルガイド（第3版）にならい、「か所」「か月」と表記します。 @@ -100,6 +114,7 @@ NG： 5 GB、10テラバイト、2byte ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1666141958261579 +{} ## 数値は3桁ごとに桁区切り記号のカンマ（ , ）を使用する ### 説明 @@ -112,4 +127,4 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1666141958261579 ### 議事録 -https://kufuinc.slack.com/archives/CJX59GJFR/p1612243424065800 +https://kufuinc.slack.com/archives/CJX59GJFR/p1612243424065800 \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/hiragana.mdx b/src/content/articles/products/contents/idiomatic-usage/hiragana.mdx index b28714f7d..0a7bb37f6 100644 --- a/src/content/articles/products/contents/idiomatic-usage/hiragana.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/hiragana.mdx @@ -6,10 +6,12 @@ ignoreH3Nav: true --- 漢字とひらがなの使い分けを定義します。 +{} ## 平仮名にしたほうが読みやすい漢字は平仮名にする ### 説明 -「[平仮名にしたほうが読みやすい漢字は平仮名にする](https://smarthr.design/products/contents/writing-style/#2-3)」というルールに従います。 +「[平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/writing-style/#use-hiragana-for-readable-words)」というルールに従います。 +{} ## ​​​​送りがなをつけて表記する ### 説明 内閣告示の「送り仮名の付け方」に従い、送りがなをつけて表記します。 @@ -18,16 +20,17 @@ ignoreH3Nav: true 書類名などの固有名詞は正式名称にあわせます。 {/* textlint-disable */} ### 例 -OK： 書き込み、取り消し +OK： 書き込み、取り消し NG： 書込、取消 ### 出典 https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kijun/naikaku/okurikana/index.html +{} ## 「行なう」と表記し、「行う」の使用は控える ### 説明 -日本語としては、「行なう」と「行う」のいずれも正しい表記です。 -しかし、「行った（おこなった）」と表記した場合、「いった」と誤読する可能性があります。 +日本語としては、「行なう」と「行う」のいずれも正しい表記です。 +しかし、「行った（おこなった）」と表記した場合、「いった」と誤読する可能性があります。 このため、「行なう」と表記した方が、ユーザーにとって親切だと判断しました。 ### 注意点 @@ -36,31 +39,35 @@ https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kijun/naikaku/okurikana/ ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1597665779077700 +{} ## 「改善」と漢字で表記し、「カイゼン」の使用は控える ### 説明 -機能の「改善」は、製造業の現場やアジャイル開発で使われる「カイゼン」とは意味が異なるため、漢字で表記します。 +機能の「改善」は、製造業の現場やアジャイル開発で使われる「カイゼン」とは意味が異なるため、漢字で表記します。 開発チーム内で「カイゼンチケット」のような使い方をしても構いません。 {/* textlint-enable */} ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1636958186072400 +{} ## 「頃」は漢字で表記する ### 説明 -「頃」は漢字で表記し、平仮名では表記しません。 +「頃」は漢字で表記し、平仮名では表記しません。 「頃」はユーザーにとって馴染みがあり、読みづらかったり、読み間違えたりするリスクが低いと判断しました。 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1649998111788489 +{} ## 前の工程に戻る場合の「元」は漢字で表記する ### 説明 前の工程に戻る場合の操作は「元に戻す」「元へ戻る」などと表記します。 「もとに」や「もとへ」と表記するよりも、漢字を使用した方がひと目で「前の工程に戻ること」を認知できると判断しました。 {/* textlint-disable */} ### 議事録 -https://kufuinc.slack.com/archives/CJX59GJFR/p1612859054114400 +https://kufuinc.slack.com/archives/CJX59GJFR/p1612859054114400 https://kufuinc.slack.com/archives/CJX59GJFR/p1649829413588279 +{} ## 拠り所や根拠を示す「もと」はひらがなで表記する ### 説明 拠り所や根拠とする「もと」は平仮名で表記し、漢字の「基」は使いません。 @@ -70,14 +77,15 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1649829413588279 OK例： 給与額をもとに NG例： 給与額を基に - +{} ## 「紐づけ」と表記し、「紐付け」の使用は控える ### 説明 「平仮名にしたほうが読みやすい漢字は平仮名にする」というルールに従い、「付ける」を「つける」と表記するのに準じて、「紐づけ」と表記します。 +{} ## 「にもかかわらず」と平仮名で表記する ### 説明 -漢字の「にも関わらず」「にも拘らず」は使用せず、平仮名の「にもかかわらず」で表記します。 +漢字の「にも関わらず」「にも拘らず」は使用せず、平仮名の「にもかかわらず」で表記します。 前述とは異なる状況へ進んだ場合の適切な漢字は「にも拘らず」ですが、漢字表記を見る機会が少なく、平仮名で表記したほうが読みやすいと判断しました。 ### 例 @@ -86,6 +94,7 @@ OK：正しい情報を入力したにもかかわらず、ログインできな ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1690962988673789 +{} ## 「あわせて」は平仮名で表記する ### 説明 漢字の「合わせて」「併せて」は基本的に使用せず、平仮名の「あわせて」で表記します。 @@ -107,12 +116,14 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1629108934076300 ### 出典 日本語スタイルガイドでは漢字表記だが、SmartHRでは平仮名表記とする。 -{/* textlint-disable */} +{/* textlint-disable */} +{} ## 「主な」「主に」は漢字で表記する ### 説明 「主な」「主に」といった表記は漢字で表記し、平仮名では表記しません。 +{} ## 「ある」はひらがなで表記する ### 説明 -漢字の「有る」「在る」は使用せず、平仮名の「ある」で表記します。 +漢字の「有る」「在る」は使用せず、平仮名の「ある」で表記します。 \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/ichiran.mdx b/src/content/articles/products/contents/idiomatic-usage/ichiran.mdx index 53e804400..0a0788140 100644 --- a/src/content/articles/products/contents/idiomatic-usage/ichiran.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/ichiran.mdx @@ -9,223 +9,222 @@ ignoreH3Nav: true ## 記号 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| !!（半角） | ！！（全角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#h2-0)| -| ??（半角） | ？？（全角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#h2-0) | -| ？（全角） | ?（半角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#h2-0) | -| !?（半角） | ！？（全角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#h2-0) | -| 15:35, 15:35:05 | 15時35分, 15時35分5秒, 3:35:5 PM | [日付は「YYYY/MM/DD」、時刻は「hh:mm:ss」と表記し、期間を表す記号は「〜」を使用する](/products/contents/idiomatic-usage/count/#h2-3)・[時刻（time）の文字列形式は、hh:mm:ssで表記します。状況に応じて、ssは省略しても構いません。](/products/contents/idiomatic-usage/count/#h2-4) | -| 2019/01/01 | 2019年1月1日 | [日付は「YYYY/MM/DD」、時刻は「hh:mm:ss」と表記し、期間を表す記号は「〜」を使用する](/products/contents/idiomatic-usage/count/#h2-3) | -| 「 」、［ ］、【 】、（ ） | 引用符`“ ”` や二重かぎ括弧 `『 』` | [括弧類は「 」、［ ］、【 】、（ ）を使用する](/products/contents/idiomatic-usage/symbol/#h2-6)| -| （変数を表す括弧）｛｝ | | [変数は\{ \}を使用する](/products/contents/idiomatic-usage/symbol/#h2-9)| -| 100,000 | 100000 | [数値は3桁ごとに桁区切り記号のカンマ（ , ）を使用する](/products/contents/idiomatic-usage/count/#h2-7)| +| !!（半角） | ！！（全角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#use-fullwidth-exclamation-and-question-mark-for-single-use-and-halfwidth-for-paired)| +| ??（半角） | ？？（全角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#use-fullwidth-exclamation-and-question-mark-for-single-use-and-halfwidth-for-paired) | +| ？（全角） | ?（半角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#use-fullwidth-exclamation-and-question-mark-for-single-use-and-halfwidth-for-paired) | +| !?（半角） | ！？（全角） | [「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する](/products/contents/idiomatic-usage/symbol/#use-fullwidth-exclamation-and-question-mark-for-single-use-and-halfwidth-for-paired) | +| 15:35, 15:35:05 | 15時35分, 15時35分5秒, 3:35:5 PM | [日付は「YYYY/MM/DD」、時刻は「hh:mm:ss」と表記し、期間を表す記号は「〜」を使用する](/products/contents/idiomatic-usage/count/#date-in-yyyy-mm-dd-time-in-hh-mm-ss-and-use-tilde-for-duration)・[時刻（time）の文字列形式は、hh:mm:ssで表記します。状況に応じて、ssは省略しても構いません。](/products/contents/idiomatic-usage/count/#date-in-yyyy-mm-dd-time-in-hh-mm-ss-and-use-tilde-for-duration) | +| 2019/01/01 | 2019年1月1日 | [日付は「YYYY/MM/DD」、時刻は「hh:mm:ss」と表記し、期間を表す記号は「〜」を使用する](/products/contents/idiomatic-usage/count/#date-in-yyyy-mm-dd-time-in-hh-mm-ss-and-use-tilde-for-duration) | +| 「 」、［ ］、【 】、（ ） | 引用符`“ ”` や二重かぎ括弧 `『 』` | [括弧類は「 」、［ ］、【 】、（ ）を使用する](/products/contents/idiomatic-usage/symbol/#use-fullwidth-brackets)| +| （変数を表す括弧）｛｝ | | [変数は\{ \}を使用する](/products/contents/idiomatic-usage/symbol/#use-braces-for-variables)| +| 100,000 | 100000 | [数値は3桁ごとに桁区切り記号のカンマ（ , ）を使用する](/products/contents/idiomatic-usage/count/#use-commas-to-separate-every-three-digits-in-numbers)| ## あ行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| アイコン | マーク | [「アイコン」と表記し、「マーク」の使用は控える](/products/contents/idiomatic-usage/component/#h2-3) | -| アクセシビリティ | アクセシビリティー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| アップロード | - | [「アップロード」と「ダウンロード」を使用する](/products/contents/idiomatic-usage/action/#h2-6) | -| あとで | 後で | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| あらかじめ | 予め | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 改めて | あらためて | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ある | 有る | [「ある」はひらがなで表記する](/products/contents/idiomatic-usage/hiragana/#h2-11) | -| あわせて | 合わせて, 併せて | [「あわせて」は平仮名で表記する](/products/contents/idiomatic-usage/hiragana/#h2-9) | -| いたします | 致します | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| いただく | 頂く | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 移動 | 遷移 | [「移動」と表記し、「遷移」の使用は控える](/products/contents/idiomatic-usage/action/#h2-7) | -| ウェイト | ウエイト | [「ウィ/ウェ/ウォ」を使用する](/products/contents/idiomatic-usage/katakana/#h2-3) | -| ウェブ | Web, web | [「ウェブ」はカタカナで表記する](/products/contents/idiomatic-usage/katakana/#h2-4) | -| ウェブサイト | Webサイト, webサイト | [「ウェブ」はカタカナで表記する](/products/contents/idiomatic-usage/katakana/#h2-4) | -| ウェブページ | Webページ, webページ | [「ウェブ」はカタカナで表記する](/products/contents/idiomatic-usage/katakana/#h2-4) | -| （バックグラウンド処理を）受け付けました | 予約しました | [バックグラウンド処理をリクエスト時の文言は「\{処理名\}を受け付けました」](/products/contents/idiomatic-usage/action/#h2-4) | -| お客さま | お客様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#h2-3) | -| 行なう | 行う | [「行なう」と表記し、「行う」の使用は控える](/products/contents/idiomatic-usage/hiragana/#h2-2) | -| （ボタンを,メニューを）押す | 押下する、クリックする, タップする | [アプリケーション上でボタンを押下する操作は「押す」と表記し、「クリック」「タップ」の使用は控える](/products/contents/idiomatic-usage/action/#h2-8) | -| 主な | おもな | [「主な」「主に」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#h2-10) | -| 主に | おもに | [「主な」「主に」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#h2-10) | -| および | 及び | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | +| アイコン | マーク | [「アイコン」と表記し、「マーク」の使用は控える](/products/contents/idiomatic-usage/component/#use-icon-and-avoid-using-mark) | +| アクセシビリティ | アクセシビリティー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| アップロード | - | [「アップロード」と「ダウンロード」を使用する](/products/contents/idiomatic-usage/action/#use-upload-and-download) | +| あとで | 後で | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| あらかじめ | 予め | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 改めて | あらためて | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ある | 有る | [「ある」はひらがなで表記する](/products/contents/idiomatic-usage/hiragana/#use-aru-in-hiragana) | +| あわせて | 合わせて, 併せて | [「あわせて」は平仮名で表記する](/products/contents/idiomatic-usage/hiragana/#use-awasete-in-hiragana) | +| いたします | 致します | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| いただく | 頂く | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 移動 | 遷移 | [「移動」と表記し、「遷移」の使用は控える](/products/contents/idiomatic-usage/action/#use-move-and-avoid-using-transition) | +| ウェイト | ウエイト | [「ウィ/ウェ/ウォ」を使用する](/products/contents/idiomatic-usage/katakana/#use-wi-we-wo-as-ui-ue-uo) | +| ウェブ | Web, web | [「ウェブ」はカタカナで表記する](/products/contents/idiomatic-usage/katakana/#write-web-in-katakana) | +| ウェブサイト | Webサイト, webサイト | [「ウェブ」はカタカナで表記する](/products/contents/idiomatic-usage/katakana/#write-web-in-katakana) | +| ウェブページ | Webページ, webページ | [「ウェブ」はカタカナで表記する](/products/contents/idiomatic-usage/katakana/#write-web-in-katakana) | +| （バックグラウンド処理を）受け付けました | 予約しました | [バックグラウンド処理をリクエスト時の文言は「\{処理名\}を受け付けました」](/products/contents/idiomatic-usage/action/#words-when-requesting-a-background-process) | +| お客さま | お客様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#customer-admin-user-calling) | +| 行なう | 行う | [「行なう」と表記し、「行う」の使用は控える](/products/contents/idiomatic-usage/hiragana/#use-okonau-and-avoid-okonau-without-na) | +| （ボタンを,メニューを）押す | 押下する、クリックする, タップする | [アプリケーション上でボタンを押下する操作は「押す」と表記し、「クリック」「タップ」の使用は控える](/products/contents/idiomatic-usage/action/#use-open-for-text-link-and-avoid-click-or-tap) | +| 主な | おもな | [「主な」「主に」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#use-omo-in-kanji) | +| および | 及び | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | ## か行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| 解除 | | [状態を戻すときの言葉（解除・差し戻し・戻すの考え方）](/products/contents/idiomatic-usage/action/#h2-2) | -| 改善 | カイゼン | [「改善」と漢字で表記し、「カイゼン」の使用は控える](/products/contents/idiomatic-usage/hiragana/#h2-3) | -| 書き出し | エクスポート,出力 | [「書き出し」と表記し、「エクスポート」の使用は控える](/products/contents/idiomatic-usage/action/#h2-9) | -| か月 | ヶ月, ケ月, 箇月, 個月, ヵ月, カ月 | [「か所」「か月」と表記する](/products/contents/idiomatic-usage/count/#h2-6) | -| か所 | ヶ所,ケ所,箇所,個所,ヵ所,カ所 | [「か所」「か月」と表記する](/products/contents/idiomatic-usage/count/#h2-6) | -| カスタムマスター | カスタムマスタ, 　カスタムマスターデータ | [マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する](/products/contents/idiomatic-usage/usage/#h2-1) | -| 画面 | ウィンドウ, ダイアログ, モーダル | [アプリケーションの操作画面は「画面」で表記する](/products/contents/idiomatic-usage/component/#h2-1)| -| 管理者さま | 管理者様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#h2-3) | -| GB | ギガバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#h2-5) | -| 企業アカウント | テナント | [企業ごとに作成するアカウントの呼び方には「企業アカウント」を使用する](/products/contents/idiomatic-usage/usage/#h2-6) | -| キャンセル | | [操作を止めるときの言葉（キャンセル・取り消し・中断の考え方）](/products/contents/idiomatic-usage/action/#h2-1) | -| KB | キロバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#h2-5) | -| クエリ | クエリー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ください | 下さい | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| グループ | セット | [「グループ」と「セット」の使い分け](/products/contents/idiomatic-usage/other/#h2-2) | -| 詳しく | くわしく | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 健康保険組合 | 健保組合, 組合健保 | [「健康保険組合」と表記し、「健保組合」「組合健保」の使用は控える](/products/contents/idiomatic-usage/usage/#h2-8) | -| 言語選択 | 言語切替, 言語切り替え, 言語切替え, 言語切換, 言語切り換え, 言語切換え | [「言語選択」と表記する](/products/contents/idiomatic-usage/action/#h2-15) | -| 検索フォーム | 検索ボックス | [「検索フォーム」と表記し、「検索ボックス」の使用は控える](/products/contents/idiomatic-usage/component/#h2-2) | -| ご存じ | ご存知 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| こと | 事 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ごと | 毎 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| コピーアンドペースト | コピー＆ペースト,　コピー・ペースト,　コピペ | [「コピーアンドペースト」と表記し、「コピー＆ペースト」の使用は控える](/products/contents/idiomatic-usage/action/#h2-16) | -| 頃 | ころ, ごろ | [「頃」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#h2-4) | +| 解除 | | [状態を戻すときの言葉（解除・差し戻し・戻すの考え方）](/products/contents/idiomatic-usage/action/#words-for-returning-state) | +| 改善 | カイゼン | [「改善」と漢字で表記し、「カイゼン」の使用は控える](/products/contents/idiomatic-usage/hiragana/#use-kaizen-in-kanji-and-avoid-kaizen-in-katakana) | +| 書き出し | エクスポート,出力 | [「書き出し」と表記し、「エクスポート」の使用は控える](/products/contents/idiomatic-usage/action/#use-write-out-and-avoid-using-export) | +| か月 | ヶ月, ケ月, 箇月, 個月, ヵ月, カ月 | [「か所」「か月」と表記する](/products/contents/idiomatic-usage/count/#use-kasho-and-kagetsu) | +| か所 | ヶ所,ケ所,箇所,個所,ヵ所,カ所 | [「か所」「か月」と表記する](/products/contents/idiomatic-usage/count/#use-kasho-and-kagetsu) | +| カスタムマスター | カスタムマスタ, 　カスタムマスターデータ | [マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する](/products/contents/idiomatic-usage/usage/#master-data-and-xx-master) | +| 画面 | ウィンドウ, ダイアログ, モーダル | [アプリケーションの操作画面は「画面」で表記する](/products/contents/idiomatic-usage/component/#refer-to-application-operation-screens-as-screen)| +| 管理者さま | 管理者様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#customer-admin-user-calling) | +| GB | ギガバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#file-size-in-two-letter-english-unit) | +| 企業アカウント | テナント | [企業ごとに作成するアカウントの呼び方には「企業アカウント」を使用する](/products/contents/idiomatic-usage/usage/#kigyou-account) | +| キャンセル | | [操作を止めるときの言葉（キャンセル・取り消し・中断の考え方）](/products/contents/idiomatic-usage/action/#words-for-stopping-an-operation) | +| KB | キロバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#file-size-in-two-letter-english-unit) | +| クエリ | クエリー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ください | 下さい | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| グループ | セット | [「グループ」と「セット」の使い分け](/products/contents/idiomatic-usage/other/#use-group-and-avoid-set) | +| 詳しく | くわしく | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 健康保険組合 | 健保組合, 組合健保 | [「健康保険組合」と表記し、「健保組合」「組合健保」の使用は控える](/products/contents/idiomatic-usage/usage/#use-kenkouhokenkumiai-and-avoid-kenpo-kumiai) | +| 言語選択 | 言語切替, 言語切り替え, 言語切替え, 言語切換, 言語切り換え, 言語切換え | [「言語選択」と表記する](/products/contents/idiomatic-usage/action/#use-language-selection) | +| 検索フォーム | 検索ボックス | [「検索フォーム」と表記し、「検索ボックス」の使用は控える](/products/contents/idiomatic-usage/component/#use-search-form-and-avoid-using-search-box) | +| ご存じ | ご存知 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| こと | 事 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ごと | 毎 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| コピーアンドペースト | コピー＆ペースト,　コピー・ペースト,　コピペ | [「コピーアンドペースト」と表記し、「コピー＆ペースト」の使用は控える](/products/contents/idiomatic-usage/action/#use-copy-and-paste) | +| 頃 | ころ, ごろ | [「頃」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#use-koro-in-kanji) | ## さ行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| サーバー | サーバ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| 在職中 | 在籍中 | [従業員の休職や退職を表すステータスの総称は「在籍状況」と表記し、勤務中の状態は「在職中」と表記する](/products/contents/idiomatic-usage/usage/#h2-5) | -| 在籍状況 | 在職状況 | [従業員の休職や退職を表すステータスの総称は「在籍状況」と表記し、勤務中の状態は「在職中」と表記する](/products/contents/idiomatic-usage/usage/#h2-5) | -| 再読み込み | 再読込,リロード | [「再読み込み」と表記し、「更新」「リロード」の使用は控える](/products/contents/idiomatic-usage/action/#h2-10) | -| さきほど | 先程 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 差し戻し | 差戻し | [状態を戻すときの言葉（解除・差し戻し・戻すの考え方）](/products/contents/idiomatic-usage/action/#h2-2) | -| さま | 様 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| さまざま | 様々 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| さらに | 更に | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 参照してください | ご確認ください,　御覧ください,　ご覧ください,　ご参照ください | [ヘルプページなどのリファレンスの閲覧を促す場合は「参照」と表記し、「確認」の使用は控える](/products/contents/idiomatic-usage/action/#h2-12) | -| システム標準マスター | システム標準マスタ,　システム標準マスターデータ | [マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する](/products/contents/idiomatic-usage/usage/#h2-1) | -| 〜したうえで | 〜した上で | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| しばらく | 暫く | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| シミュレーション | シュミレーション | [「シミュレーション」と表記し、「シュミレーション」の使用は控える](/products/contents/idiomatic-usage/katakana/#h2-7) | -| 自由記述 | フリーテキスト | [「自由記述」と表記し、「フリーテキスト」の使用は控える](/products/contents/idiomatic-usage/other/#h2-8)| -| （主語がプロダクトの時）使用 | 利用 | [アプリケーションが主語のときは「使用」と表記し、「利用」の使用は控える](/products/contents/idiomatic-usage/action/#h2-11) | -| すでに | 既に | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| すなわち | 即ち | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| すべて | 全て | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| SmartHRオプション機能,　オプション機能 | プラスアプリ | [アプリケーションの呼び方には「SmartHR基本機能」と「オプション機能」を使用する](/products/contents/idiomatic-usage/usage/#h2-2) | -| SmartHRオプション機能の管理者,　組織図機能管理者,　サーベイ機能管理者,　評価機能管理者,　配置シミュレーション管理者 | SmartHR管理者,　SmartHRの管理者 | [管理者の呼称は、基本機能とオプション機能の区別がわかるように表記する](/products/contents/idiomatic-usage/usage/#h2-4) | -| SmartHR基本機能, 　基本機能 | SmartHR本体,　本体アプリ | [アプリケーションの呼び方には「SmartHR基本機能」と「オプション機能」を使用する](/products/contents/idiomatic-usage/usage/#h2-2) | -| SmartHR基本機能の管理者,　基本機能管理者 | SmartHR管理者,　SmartHRの管理者 | [管理者の呼称は、基本機能とオプション機能の区別がわかるように表記する](/products/contents/idiomatic-usage/usage/#h2-4) | -| スマートフォン | スマホ, スマフォ,　スマートホン | [「スマートフォン」と表記し、「スマホ」などの表記は控える](/products/contents/idiomatic-usage/katakana/#h2-1) | -| セキュリティ | セキュリティー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ぜひ | 是非 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| （ラジオボタンを）　選択する | | [ラジオボタンの項目を選ぶ操作は「選択する」と表記する](/products/contents/idiomatic-usage/action/#h2-17) | -| そば | 側 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ソフトウェア | ソフトウエア | [「ウィ/ウェ/ウォ」を使用する](/products/contents/idiomatic-usage/katakana/#h2-3) | +| サーバー | サーバ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| 在職中 | 在籍中 | [従業員の休職や退職を表すステータスの総称は「在籍状況」と表記し、勤務中の状態は「在職中」と表記する](/products/contents/idiomatic-usage/usage/#zaiseikujoukyou-and-zaishokuchu) | +| 在籍状況 | 在職状況 | [従業員の休職や退職を表すステータスの総称は「在籍状況」と表記し、勤務中の状態は「在職中」と表記する](/products/contents/idiomatic-usage/usage/#zaiseikujoukyou-and-zaishokuchu) | +| 再読み込み | 再読込,リロード | [「再読み込み」と表記し、「更新」「リロード」の使用は控える](/products/contents/idiomatic-usage/action/#use-saiyomikomi-instead-of-update-or-reload) | +| さきほど | 先程 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 差し戻し | 差戻し | [状態を戻すときの言葉（解除・差し戻し・戻すの考え方）](/products/contents/idiomatic-usage/action/#words-for-returning-state) | +| さま | 様 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| さまざま | 様々 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| さらに | 更に | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 参照してください | ご確認ください,　御覧ください,　ご覧ください,　ご参照ください | [ヘルプページなどのリファレンスの閲覧を促す場合は「参照」と表記し、「確認」の使用は控える](/products/contents/idiomatic-usage/action/#when-prompting-users-to-view-reference-use-refer-and-avoid-confirm) | +| システム標準マスター | システム標準マスタ,　システム標準マスターデータ | [マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する](/products/contents/idiomatic-usage/usage/#master-data-and-xx-master) | +| 〜したうえで | 〜した上で | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| しばらく | 暫く | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| シミュレーション | シュミレーション | [「シミュレーション」と表記し、「シュミレーション」の使用は控える](/products/contents/idiomatic-usage/katakana/#use-simulation-and-avoid-shumireshon) | +| 自由記述 | フリーテキスト | [「自由記述」と表記し、「フリーテキスト」の使用は控える](/products/contents/idiomatic-usage/other/#use-jiyu-kijutsu-and-avoid-free-text)| +| （主語がプロダクトの時）使用 | 利用 | [アプリケーションが主語のときは「使用」と表記し、「利用」の使用は控える](/products/contents/idiomatic-usage/action/#when-the-application-is-the-subject-use-shiyou-and-avoid-riyou) | +| すでに | 既に | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| すなわち | 即ち | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| すべて | 全て | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| SmartHRオプション機能,　オプション機能 | プラスアプリ | [アプリケーションの呼び方には「SmartHR基本機能」と「オプション機能」を使用する](/products/contents/idiomatic-usage/usage/#smarthr-basic-function-and-option-function) | +| SmartHRオプション機能の管理者,　組織図機能管理者,　サーベイ機能管理者,　評価機能管理者,　配置シミュレーション管理者 | SmartHR管理者,　SmartHRの管理者 | [管理者の呼称は、基本機能とオプション機能の区別がわかるように表記する](/products/contents/idiomatic-usage/usage/#how-to-call-admin-basic-and-option-function) | +| SmartHR基本機能, 　基本機能 | SmartHR本体,　本体アプリ | [アプリケーションの呼び方には「SmartHR基本機能」と「オプション機能」を使用する](/products/contents/idiomatic-usage/usage/#smarthr-basic-function-and-option-function) | +| SmartHR基本機能の管理者,　基本機能管理者 | SmartHR管理者,　SmartHRの管理者 | [管理者の呼称は、基本機能とオプション機能の区別がわかるように表記する](/products/contents/idiomatic-usage/usage/#how-to-call-admin-basic-and-option-function) | +| スマートフォン | スマホ, スマフォ,　スマートホン | [「スマートフォン」と表記し、「スマホ」などの表記は控える](/products/contents/idiomatic-usage/katakana/#use-smartphone-and-avoid-sumaho) | +| セキュリティ | セキュリティー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ぜひ | 是非 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| （ラジオボタンを）　選択する | | [ラジオボタンの項目を選ぶ操作は「選択する」と表記する](/products/contents/idiomatic-usage/action/#use-select-when-choosing-radio-button-options) | +| そば | 側 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ソフトウェア | ソフトウエア | [「ウィ/ウェ/ウォ」を使用する](/products/contents/idiomatic-usage/katakana/#use-wi-we-wo-as-ui-ue-uo) | ## た行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| タイポグラフィ | タイポグラフィー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ダウンロード | - | [「アップロード」と「ダウンロード」を使用する](/products/contents/idiomatic-usage/action/#h2-6) | -| たくさん | 沢山 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ただ | 只 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ただし | 但し | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| サンプル | ダミー | [「サンプル」と表記し、「ダミー」は使用しない](/products/contents/idiomatic-usage/other/#h2-5)| -| ため | 為 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 担当者さま | 担当者様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#h2-3) | -| （チェックボックスに）　チェックを入れる/外す | チェックする | [チェックボックスの操作は「チェックを入れる/外す」と表記する](/products/contents/idiomatic-usage/action/#h2-18) | -| 中断 | | [操作を止めるときの言葉（キャンセル・取り消し・中断の考え方）](/products/contents/idiomatic-usage/action/#h2-1) | -| 追加 | 作成,登録　※「追加」を使うと違和感がある場合は、社内Slack#design_system_相談で気軽に相談してください。 | [「つくる」操作を表す文言](/products/contents/idiomatic-usage/action/#h2-0) | -| つける | 付ける | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| できる | 出来る | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 手引き | 手引 | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#h2-1) | -| デフォルト | プリセット | [「デフォルト」と「プリセット」の使い分け](/products/contents/idiomatic-usage/other/#h2-0) | -| TB | テラバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#h2-5) | -| 展開 | 解凍, 開く | [ZIPファイルの「展開」と表記し、「解凍」または「開く」の使用は控える](/products/contents/idiomatic-usage/action/#h2-21) | -| テンプレート | フォーマット | [「テンプレート」と「フォーマット」の使い分け](/products/contents/idiomatic-usage/other/#h2-1) | -| 問い合わせ | 問合せ | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#h2-1) | -| 動作環境 | 推奨環境 | [「動作環境」と表記し、「推奨環境」の使用は控える](/products/contents/idiomatic-usage/other/#h2-3)| -| とおり | 通り | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| とき | 時 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 得意な言語 | 母語, 母国語 | [「得意な言語」と表記し、「母国語」「母語」の使用は控える](/products/contents/idiomatic-usage/other/#h2-6) | -| ともに | 共に | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 伴う | ともなう | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ドラッグアンドドロップ | ドラッグ＆ドロップ,　ドラッグ・ドロップ | [「ドラッグアンドドロップ」と表記し、「ドラッグ＆ドロップ」や「ドラッグ・ドロップ」の使用は控える](/products/contents/idiomatic-usage/action/#h2-19) | -| 取り消し | 取消 | [操作を止めるときの言葉（キャンセル・取り消し・中断の考え方）](/products/contents/idiomatic-usage/action/#h2-1) | -| 取り込み | インポート | [ファイルを取り込んで操作するときの文言](/products/contents/idiomatic-usage/action/#h2-3) 、 [「取り込み」と表記し、「インポート」の使用は控える](/products/contents/idiomatic-usage/action/#h2-5) | -| ドロップダウンリスト | プルダウン,　プルダウンメニュー,　プルダウンリスト,　ドロップダウン,　ドロップダウンメニュー | [「ドロップダウンリスト」と表記し、「プルダウンメニュー」などの使用は控える](/products/contents/idiomatic-usage/component/#h2-0) | +| タイポグラフィ | タイポグラフィー | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ダウンロード | - | [「アップロード」と「ダウンロード」を使用する](/products/contents/idiomatic-usage/action/#use-upload-and-download) | +| たくさん | 沢山 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ただ | 只 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ただし | 但し | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| サンプル | ダミー | [「サンプル」と表記し、「ダミー」は使用しない](/products/contents/idiomatic-usage/other/#use-sample-and-avoid-dummy)| +| ため | 為 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 担当者さま | 担当者様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#customer-admin-user-calling) | +| （チェックボックスに）　チェックを入れる/外す | チェックする | [チェックボックスの操作は「チェックを入れる/外す」と表記する](/products/contents/idiomatic-usage/action/#use-check-irereru-hazusu-for-checkbox-operations) | +| 中断 | | [操作を止めるときの言葉（キャンセル・取り消し・中断の考え方）](/products/contents/idiomatic-usage/action/#words-for-stopping-an-operation) | +| 追加 | 作成,登録　※「追加」を使うと違和感がある場合は、社内Slack#design_system_相談で気軽に相談してください。 | [「つくる」操作を表す文言](/products/contents/idiomatic-usage/action/#word-for-create-operation) | +| つける | 付ける | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| できる | 出来る | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 手引き | 手引 | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#attach-okurigana) | +| デフォルト | プリセット | [「デフォルト」と「プリセット」の使い分け](/products/contents/idiomatic-usage/other/#difference-between-default-and-preset) | +| TB | テラバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#file-size-in-two-letter-english-unit) | +| 展開 | 解凍, 開く | [ZIPファイルの「展開」と表記し、「解凍」または「開く」の使用は控える](/products/contents/idiomatic-usage/action/#use-extract-for-zip-files) | +| テンプレート | フォーマット | [「テンプレート」と「フォーマット」の使い分け](/products/contents/idiomatic-usage/other/#use-template-and-avoid-format) | +| 問い合わせ | 問合せ | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#attach-okurigana) | +| 動作環境 | 推奨環境 | [「動作環境」と表記し、「推奨環境」の使用は控える](/products/contents/idiomatic-usage/other/#use-operating-environment-and-avoid-recommended-environment)| +| とおり | 通り | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| とき | 時 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 得意な言語 | 母語, 母国語 | [「得意な言語」と表記し、「母国語」「母語」の使用は控える](/products/contents/idiomatic-usage/other/#use-tokui-na-gengo) | +| ともに | 共に | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 伴う | ともなう | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ドラッグアンドドロップ | ドラッグ＆ドロップ,　ドラッグ・ドロップ | [「ドラッグアンドドロップ」と表記し、「ドラッグ＆ドロップ」や「ドラッグ・ドロップ」の使用は控える](/products/contents/idiomatic-usage/action/#use-drag-and-drop) | +| 取り消し | 取消 | [操作を止めるときの言葉（キャンセル・取り消し・中断の考え方）](/products/contents/idiomatic-usage/action/#words-for-stopping-an-operation) | +| 取り込み | インポート | [ファイルを取り込んで操作するときの文言](/products/contents/idiomatic-usage/action/#words-for-operations-when-importing-a-file) 、 [「取り込み」と表記し、「インポート」の使用は控える](/products/contents/idiomatic-usage/action/#use-import-and-avoid-using-torikomi) | +| ドロップダウンリスト | プルダウン,　プルダウンメニュー,　プルダウンリスト,　ドロップダウン,　ドロップダウンメニュー | [「ドロップダウンリスト」と表記し、「プルダウンメニュー」などの使用は控える](/products/contents/idiomatic-usage/component/#use-dropdown-list-and-avoid-using-pull-down-menu) | ## な行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| ない | 無い | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 〜なかで | 〜中で | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| など | 等 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 何卒 | 何とぞ | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 並び順, 横並び, 縦並び | ならび順, 横ならび, 縦ならび | 例外： [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ならびに | 並びに | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 並べ替え | 並び替え | [「並べ替え」と表記する](/products/contents/idiomatic-usage/action/#h2-20) | -| ナンバー | ナンバ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| にもかかわらず | にも関わらず, にも拘らず,にも係わらず | [「にもかかわらず」と平仮名で表記する](/products/contents/idiomatic-usage/hiragana/#h2-8) | -| 入力必須 | 必須入力 | [「入力必須」と表記し、「必須入力」の使用は控える](/products/contents/idiomatic-usage/other/#h2-4) | -| 〜のうえ | 〜の上 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0)| +| ない | 無い | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 〜なかで | 〜中で | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| など | 等 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 何卒 | 何とぞ | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 並び順, 横並び, 縦並び | ならび順, 横ならび, 縦ならび | 例外： [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ならびに | 並びに | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 並べ替え | 並び替え | [「並べ替え」と表記する](/products/contents/idiomatic-usage/action/#use-narabekae) | +| ナンバー | ナンバ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| にもかかわらず | にも関わらず, にも拘らず,にも係わらず | [「にもかかわらず」と平仮名で表記する](/products/contents/idiomatic-usage/hiragana/#use-nimokakawarazu-in-hiragana) | +| 入力必須 | 必須入力 | [「入力必須」と表記し、「必須入力」の使用は控える](/products/contents/idiomatic-usage/other/#use-nyuuryoku-hisshu-and-avoid-hisshu-nyuuryoku) | +| 〜のうえ | 〜の上 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana)| ## は行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| バイト | B, byte | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#h2-5) | -| はじめて | 初めて, 始めて | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| パソコン | PC | [「パソコン」と表記し、「PC」の使用は控える](/products/contents/idiomatic-usage/katakana/#h2-0)| -| 1つ | 一つ, ひとつ | [数字は半角の算用数字で表記する](/products/contents/idiomatic-usage/count/#h2-0) | -| 1人 | 一人, ひとり | [数字は半角の算用数字で表記する](/products/contents/idiomatic-usage/count/#h2-0) | -| ひな形 | 雛形 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| 紐づけ | 紐付け | [「紐づけ」と表記し、「紐付け」の使用は控える](/products/contents/idiomatic-usage/hiragana/#h2-7) | -| （リンクを）開く | クリックする,タップする | [アプリケーション上でテキストリンクを押下する操作は「開く」と表記し、「クリック」「タップ」の使用は控える](/products/contents/idiomatic-usage/action/#h2-13) | +| バイト | B, byte | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#file-size-in-two-letter-english-unit) | +| はじめて | 初めて, 始めて | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| パソコン | PC | [「パソコン」と表記し、「PC」の使用は控える](/products/contents/idiomatic-usage/katakana/#use-pasokon-and-avoid-pc)| +| 1つ | 一つ, ひとつ | [数字は半角の算用数字で表記する](/products/contents/idiomatic-usage/count/#use-halfwidth-arabic-numerals-for-numbers) | +| 1人 | 一人, ひとり | [数字は半角の算用数字で表記する](/products/contents/idiomatic-usage/count/#use-halfwidth-arabic-numerals-for-numbers) | +| ひな形 | 雛形 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| 紐づけ | 紐付け | [「紐づけ」と表記し、「紐付け」の使用は控える](/products/contents/idiomatic-usage/hiragana/#use-zuke-of-himozuke-in-hiragana) | +| （リンクを）開く | クリックする,タップする | [アプリケーション上でテキストリンクを押下する操作は「開く」と表記し、「クリック」「タップ」の使用は控える](/products/contents/idiomatic-usage/action/#use-open-for-text-link-and-avoid-click-or-tap) | | （ドロップダウンリストを）　開く/閉じる | 展開する | | -| ZIPファイル | zipファイル | [「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する](/products/contents/idiomatic-usage/katakana/#h2-5)| -| PDFファイル | pdfファイル | [「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する](/products/contents/idiomatic-usage/katakana/#h2-5) | -| CSVファイル | csvファイル | [「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する](/products/contents/idiomatic-usage/katakana/#h2-5) | -| フィルター | フィルタ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| フォルダ | フォルダー | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2)| -| 複製 | コピー | [「複製」と表記し、「コピー」の使用は控える](/products/contents/idiomatic-usage/action/#h2-14) | -| 2つ | 二つ, ふたつ | [数字は半角の算用数字で表記する](/products/contents/idiomatic-usage/count/#h2-0) | -| フッター | フッタ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| プライバシー | プライバシィ, プライバシ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ブラウザ | ブラウザー | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ブラウザ | ウェブブラウザ,　Webブラウザ,　webブラウザ | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| 振り込み | 振込 | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#h2-1) | -| プリンター | プリンタ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| 扶養しない家族 | 扶養親族,被扶養者,扶養家族 | [「扶養する家族」「扶養しない家族」と表記し、「扶養家族」の使用は控える](/products/contents/idiomatic-usage/usage/#h2-10) | -| 扶養する家族 | 扶養親族,被扶養者,扶養家族 | [「扶養する家族」「扶養しない家族」と表記し、「扶養家族」の使用は控える](/products/contents/idiomatic-usage/usage/#h2-10) | -| 文書配付 | 文書配布 | [「文書配付」と表記し、「文書配布」と表記しない。](/products/contents/idiomatic-usage/usage/#h2-7) | -| ヘッダー | ヘッダ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ホーム | トップ | [アプリケーションで最初に表示される画面は「ホーム」と表記し、「トップ」「トップページ」の使用は控える](/products/contents/idiomatic-usage/usage/#h2-0)| -| ほか | 他 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ほぐす | 解す | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| ポリシー | ポリシィ, ポリシ | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | +| ZIPファイル | zipファイル | [「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する](/products/contents/idiomatic-usage/katakana/#file-names-use-uppercase-or-official-style-and-omit-extension)| +| PDFファイル | pdfファイル | [「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する](/products/contents/idiomatic-usage/katakana/#file-names-use-uppercase-or-official-style-and-omit-extension) | +| CSVファイル | csvファイル | [「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する](/products/contents/idiomatic-usage/katakana/#file-names-use-uppercase-or-official-style-and-omit-extension) | +| フィルター | フィルタ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| フォルダ | フォルダー | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings)| +| 複製 | コピー | [「複製」と表記し、「コピー」の使用は控える](/products/contents/idiomatic-usage/action/#use-duplicate-and-avoid-copy) | +| 2つ | 二つ, ふたつ | [数字は半角の算用数字で表記する](/products/contents/idiomatic-usage/count/#use-halfwidth-arabic-numerals-for-numbers) | +| フッター | フッタ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| プライバシー | プライバシィ, プライバシ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ブラウザ | ブラウザー | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ブラウザ | ウェブブラウザ,　Webブラウザ,　webブラウザ | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| 振り込み | 振込 | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#attach-okurigana) | +| プリンター | プリンタ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| 扶養しない家族 | 扶養親族,被扶養者,扶養家族 | [「扶養する家族」「扶養しない家族」と表記し、「扶養家族」の使用は控える](/products/contents/idiomatic-usage/usage/#avoid-using-fuyou-kazoku) | +| 扶養する家族 | 扶養親族,被扶養者,扶養家族 | [「扶養する家族」「扶養しない家族」と表記し、「扶養家族」の使用は控える](/products/contents/idiomatic-usage/usage/#avoid-using-fuyou-kazoku) | +| 文書配付 | 文書配布 | [「文書配付」と表記し、「文書配布」と表記しない。](/products/contents/idiomatic-usage/usage/#bunsho-haihu) | +| ヘッダー | ヘッダ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ホーム | トップ | [アプリケーションで最初に表示される画面は「ホーム」と表記し、「トップ」「トップページ」の使用は控える](/products/contents/idiomatic-usage/usage/#use-home-instead-of-top-or-top-page)| +| ほか | 他 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ほぐす | 解す | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| ポリシー | ポリシィ, ポリシ | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | ## ま行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| Microsoft Excel | Excel | [他社製品の名称は正式名で記載し、TMなどの表記は不要とする](/products/contents/idiomatic-usage/katakana/#h2-6) | -| まず | 先ず | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| マスターデータ | マスタ,マスター | [マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する](/products/contents/idiomatic-usage/usage/#h2-1)、 [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| また | 又 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| まで | 迄 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| マネージャー | マネージャ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| 見積もり | 見積り | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#h2-1) | -| MB | メガバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#h2-5) | -| （従業員を数える場合）1名 | | [従業員に関連する数え方の表記](/products/contents/idiomatic-usage/count/#h2-2) | -| ［\{機能名\}］メニュー | ［\{機能名\}］メニュー］、ナビゲーション |[AppNaviは「［｛機能名｝］メニュー」と表記する](/products/contents/idiomatic-usage/usage/#h2-9)| -| メンバー | メンバ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| もって | 以て | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | -| もっとも | 尤も | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | +| Microsoft Excel | Excel | [他社製品の名称は正式名で記載し、TMなどの表記は不要とする](/products/contents/idiomatic-usage/katakana/#official-product-names-without-tm) | +| まず | 先ず | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| マスターデータ | マスタ,マスター | [マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する](/products/contents/idiomatic-usage/usage/#master-data-and-xx-master)、 [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| また | 又 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| まで | 迄 | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| マネージャー | マネージャ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| 見積もり | 見積り | [送りがなをつけて表記する](/products/contents/idiomatic-usage/hiragana/#attach-okurigana) | +| MB | メガバイト | [ファイルサイズは英字2文字で表記する](/products/contents/idiomatic-usage/count/#file-size-in-two-letter-english-unit) | +| （従業員を数える場合）1名 | | [従業員に関連する数え方の表記](/products/contents/idiomatic-usage/count/#counting-of-employees) | +| ［\{機能名\}］メニュー | ［\{機能名\}］メニュー］、ナビゲーション |[AppNaviは「［｛機能名｝］メニュー」と表記する](/products/contents/idiomatic-usage/usage/#use-menu-label-in-appnavi)| +| メンバー | メンバ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| もって | 以て | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | +| もっとも | 尤も | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | | 最も | もっとも | | -| 元に戻す, 元へ戻す | もとに戻す, もとへ戻す | [前の工程に戻る場合の「元」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#h2-5)、[状態を戻すときの言葉（解除・差し戻し・戻すの考え方）](/products/contents/idiomatic-usage/action/#h2-2) | -| （情報を）もとに | 基に | [拠り所や根拠を示す「もと」はひらがなで表記する](/products/contents/idiomatic-usage/hiragana/#h2-6) | +| 元に戻す, 元へ戻す | もとに戻す, もとへ戻す | [前の工程に戻る場合の「元」は漢字で表記する](/products/contents/idiomatic-usage/hiragana/#use-moto-in-kanji-for-going-back-to-previous-step)、[状態を戻すときの言葉（解除・差し戻し・戻すの考え方）](/products/contents/idiomatic-usage/action/#words-for-returning-state) | +| （情報を）もとに | 基に | [拠り所や根拠を示す「もと」はひらがなで表記する](/products/contents/idiomatic-usage/hiragana/#use-moto-in-hiragana-for-basis) | ## や行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| ユーザー | ユーザ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ユーザーさま | ユーザー様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#h2-3) | -| ユーザビリティ | ユーザビリティー,　ユーザービリティ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| ヨミガナ | フリガナ | [「ヨミガナ」と表記し、「フリガナ」の使用は控える](/products/contents/idiomatic-usage/other/#h2-9) | -| よろしく | 宜しく | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | +| ユーザー | ユーザ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ユーザーさま | ユーザー様 | [ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける](/products/contents/idiomatic-usage/usage/#customer-admin-user-calling) | +| ユーザビリティ | ユーザビリティー,　ユーザービリティ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| ヨミガナ | フリガナ | [「ヨミガナ」と表記し、「フリガナ」の使用は控える](/products/contents/idiomatic-usage/other/#use-yomigana-instead-of-furigana) | +| よろしく | 宜しく | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | ## ら行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| 例： | （例） | [例を示すときには、コロン（：）を使用する](/products/contents/idiomatic-usage/symbol/#h2-10)| -| レイヤー | レイヤ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | -| レビュアー | レビュア,レビュワー | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#h2-2) | +| 例： | （例） | [例を示すときには、コロン（：）を使用する](/products/contents/idiomatic-usage/symbol/#use-colon-for-examples)| +| レイヤー | レイヤ | [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | +| レビュアー | レビュア,レビュワー | 例外： [‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり）](/products/contents/idiomatic-usage/katakana/#long-vowels-for-er-or-ar-endings-no-long-vowels-for-y-endings) | ## わ行 | 推奨する表記 | 非推奨 | 詳細 | | --- | --- | --- | -| わかる | 分かる, 判る, 解る | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#h2-0) | +| わかる | 分かる, 判る, 解る | [平仮名にしたほうが読みやすい漢字は平仮名にする](/products/contents/idiomatic-usage/hiragana/#use-hiragana-for-kanji-that-is-easier-to-read-as-hiragana) | {/* textlint-enable */} diff --git a/src/content/articles/products/contents/idiomatic-usage/katakana.mdx b/src/content/articles/products/contents/idiomatic-usage/katakana.mdx index 2bc0ddf10..f5440d37c 100644 --- a/src/content/articles/products/contents/idiomatic-usage/katakana.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/katakana.mdx @@ -6,6 +6,7 @@ ignoreH3Nav: true --- カタカナ語の表記について定義しています。 {/* textlint-disable */} +{} ## 「パソコン」と表記し、「PC」の使用は控える ### 説明 PCは略語のため、パソコンの方がさまざまなユーザーにとって馴染みがあると判断しました。 @@ -13,66 +14,70 @@ PCは略語のため、パソコンの方がさまざまなユーザーにとっ ### 議事録 https://kufuinc.slack.com/archives/C01L7GK9APK/p1661762776670439 +{} ## 「スマートフォン」と表記し、「スマホ」などの表記は控える ### 説明 -アプリケーションやヘルプセンターでは「スマートフォン」に表記を統一し、誤解を生まないようにします。 +アプリケーションやヘルプセンターでは「スマートフォン」に表記を統一し、誤解を生まないようにします。 ただし、マーケティングなど別のコミュニケーションでは、この限りではありません。 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1604647711088000 - +{} ## ‐er、‐or、‐arで終わる単語は「長音あり」、-yで終わる単語は「長音なし」とする（例外あり） ### 説明 日本語としてカナ表記が一般化している単語は、英語表記をしたときの語尾によって長音（ー）の有無を決定します。 ### 例 -‐er、‐or、‐arで終わる単語は長音をつける +‐er、‐or、‐arで終わる単語は長音をつける 例：ユーザー、マスター、フィルター --yで終わる単語は基本的に長音をつけない +-yで終わる単語は基本的に長音をつけない 例：セキュリティ、アクセシビリティ ### 例外 -browserは、ブラウザ +browserは、ブラウザ folderは、フォルダ ### 議事録 https://smarthr-inc.docbase.io/posts/1781503 +{} ## 「ウィ/ウェ/ウォ」を使用する ### 説明 -外来語の「wi/we/wo」をカタカナで表記する場合は、「ウィ/ウェ/ウォ」と表記します。 +外来語の「wi/we/wo」をカタカナで表記する場合は、「ウィ/ウェ/ウォ」と表記します。 「ウイ/ウエ/ウオ」と表記すると、別のものを指している印象を与える可能性があるため、「ウィ/ウェ/ウォ」に統一しました。 ### 例 -OK： ウィンドウ、ウェイト、ソフトウェア +OK： ウィンドウ、ウェイト、ソフトウェア NG： ウインドウ、ウエイト、ソフトウエア ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1601863186019500 ### 出典 -NHKの調査（2012年）では「ソフトウェア」が主流 +NHKの調査（2012年）では「ソフトウェア」が主流 https://www.nhk.or.jp/bunken/summary/kotoba/yougo/pdf/091.pdf +{} ## 「ウェブ」はカタカナで表記する ### 説明 -固有名詞でない限り、「ウェブ」と表記します。 -広報での議論を参考に、プロダクト側も同じガイドラインで統一することにしました。広報で「ウェブ」を採用した根拠は以下の通りです。 -元はWorld Wide Web（略してWeb） -現在は欧米では「The web」と表記されることが多い +固有名詞でない限り、「ウェブ」と表記します。 +広報での議論を参考に、プロダクト側も同じガイドラインで統一することにしました。広報で「ウェブ」を採用した根拠は以下の通りです。 +元はWorld Wide Web（略してWeb） +現在は欧米では「The web」と表記されることが多い カタカナ表記の「ウェブ」は日本語として定着している ### 例外 「Webhook」「PCAクラウドWeb-API」のような固有名詞は「Web」と表記します。また「ウェブブラウザ」は、単に「ブラウザ」とします。 +{} ## 「◯◯ファイル」の◯◯の部分は大文字か開発元公式の書き方で表記し、拡張子は省略する ### 説明 「◯◯ファイル」の◯◯の部分は、略称の場合はすべて大文字で表記するか、開発元公式の書き方に合わせます。 ### 例 -OK： CSVファイル、Excelファイル、Wordファイル +OK： CSVファイル、Excelファイル、Wordファイル NG： .csvファイル、.xlsxファイル ### 議事録 @@ -81,19 +86,21 @@ https://kufuinc.slack.com/archives/C01AF112SMS/p1613974530019200?thread_ts=16139 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1621227498284100 +{} ## 他社製品の名称は正式名で記載し、TMなどの表記は不要とする ### 例 -OK： Microsoft Excel +OK： Microsoft Excel NG： Excel、Word ### 例外 -SmartHRがベンダーなどの立場でライセンス契約を結んでいる場合には、契約先のレギュレーションに則ります。 +SmartHRがベンダーなどの立場でライセンス契約を結んでいる場合には、契約先のレギュレーションに則ります。 例：NPS® ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1622015870019300 +{} ## 「シミュレーション」と表記し、「シュミレーション」の使用は控える ### 例 例：配置シミュレーション機能 -{/* textlint-enable */} +{/* textlint-enable */} \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/other.mdx b/src/content/articles/products/contents/idiomatic-usage/other.mdx index 5762497ac..a18da4c45 100644 --- a/src/content/articles/products/contents/idiomatic-usage/other.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/other.mdx @@ -1,11 +1,12 @@ --- title: 'その他類似する用語の使い分け' -description: その他の用語の使い分けについて定義しています。' +description: 'その他の用語の使い分けについて定義しています。' order: 9 ignoreH3Nav: true --- その他の用語の使い分けについて定義しています。 {/* textlint-disable */} +{} ## 「デフォルト」と「プリセット」の使い分け ### 説明 @@ -28,9 +29,9 @@ OK：データがあらかじめ用意されています。 NG：データがプリセットされています。 ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1637839749187700 +{} ## 「テンプレート」と「フォーマット」の使い分け ### 説明 @@ -40,6 +41,7 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1637839749187700 - 書類テンプレート - 評価テンプレート +{} ## 「グループ」と「セット」の使い分け ### 説明 @@ -50,22 +52,23 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1637839749187700 - 依頼グループ - 書類グループ +{} ## 「動作環境」と表記し、「推奨環境」の使用は控える ### 説明 -SmartHRが不具合なく動作する環境のことを「動作環境」と表記します。 +SmartHRが不具合なく動作する環境のことを「動作環境」と表記します。 「推奨環境」と表記すると、要件を満たさない環境でも正常に動作するように受け取れるため、「動作環境」の方が適切だと判断しました。 ### 議事録 - -議論 +議論 : https://kufuinc.slack.com/archives/CJX59GJFR/p1633931378142200 -議論のまとめ +議論のまとめ : https://smarthr-inc.docbase.io/posts/2172951 -社外向けのお知らせ +社外向けのお知らせ : https://smarthr.jp/news/32446 +{} ## 「入力必須」と表記し、「必須入力」の使用は控える ### 説明 入力が必要な場合は「入力必須」と表記します。「必須入力」は使用しません。 @@ -73,44 +76,51 @@ SmartHRが不具合なく動作する環境のことを「動作環境」と表 ### 理由 管理者が入力フォームを作成する際、「従業員が入力する時の必須項目にしたい」というメンタルモデルを持っているため、ラベルとして［入力（を）必須（にする）］の順序が自然と判断しました。 -**項目を指すとき** +**項目を指すとき ** OK：［入力必須項目］ NG：［必須入力項目］ -**設定時のラベル** +**設定時のラベル ** OK：［入力必須］または［必須］ ※UIによって、どちらを使用するかを判断する。 + NG：［必須入力］ ### 議事録 https://smarthr-inc.docbase.io/posts/2178376 +{} ## 「サンプル」と表記し、「ダミー」は使用しない ### 説明 英単語の「dummy」はネガティブな意味を持つため、「ダミー」は使用しません。代わりに「サンプル」を使用します。 ### 例 OK例：サンプルデータ + NG例：ダミーデータ ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1697531663742579 +{} ## 「得意な言語」と表記し、「母国語」「母語」の使用は控える ### 説明 -多言語対応に関する記載において、「その人が十分に理解できる言語」は「得意な言語」と表記します。 -SmartHRが提供する多言語対応は、「その言語を子供の頃に自然に身につけた人」だけでなく「その言語を後から学んで十分に理解できるようになった人」も対象としているため、「母語」や「母国語」ではなく「得意な言語」と表記します。 +多言語対応に関する記載において、「その人が十分に理解できる言語」は「得意な言語」と表記します。 +SmartHRが提供する多言語対応は、「その言語を子供の頃に自然に身につけた人」だけでなく「その言語を後から学んで十分に理解できるようになった人」も対象としているため、「母語」や「母国語」ではなく「得意な言語」と表記します。 また、習熟度や使われる地域の限定がない場合は、単に「言語」と表記します。 ### 例 OK例：外国人従業員は、得意な言語で情報を入力できます。 -NG例：外国人従業員は、母国語で情報を入力できます。 + +NG例：外国人従業員は、母国語で情報を入力できます。 OK例：SmartHRでは、様々な言語の従業員の利用を想定して、多言語化対応を進めています。 + NG例：SmartHRでは、様々な母国語の従業員の利用を想定して、多言語化対応を進めています。 ### 議事録 https://smarthr-inc.docbase.io/posts/2735905 +{} ## 条件を示す「場合」「とき」の使い分け ### 説明 @@ -118,7 +128,7 @@ https://smarthr-inc.docbase.io/posts/2735905 ### 条件が1つの場合の例 -- 追加した項目を、従業員に閲覧・更新させたい`場合`、権限の設定が必要です。 +- 追加した項目を、従業員に閲覧・更新させたい`場合`、権限の設定が必要です。 - 同じ部署や、その上位部署に所属する従業員を承認者にしたい`とき`に利用します。 ### 大前提の条件、小前提の条件がある場合の例 @@ -128,11 +138,13 @@ https://smarthr-inc.docbase.io/posts/2735905 ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1672900957446949 +{} ## 「自由記述」と表記し、「フリーテキスト」の使用は控える ### 説明 「カタカナ語を用いるときには、まず漢字語での言い換えを検討する」に則って、フリーテキストは「自由記述」と表記します。 {/* textlint-enable */} +{} ## 「ヨミガナ」と表記し、「フリガナ」の使用は控える ### 説明 diff --git a/src/content/articles/products/contents/idiomatic-usage/symbol.mdx b/src/content/articles/products/contents/idiomatic-usage/symbol.mdx index 216cd491e..cf3c8f05d 100644 --- a/src/content/articles/products/contents/idiomatic-usage/symbol.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/symbol.mdx @@ -6,44 +6,45 @@ ignoreH3Nav: true --- 括弧や句点、スペースの使い方などを定義しています。 +{} ## 「！」と「？」は単独で使う場合は全角、ペアで使う場合は半角で表記する ### 説明 「！」「？」「!?」「!!」という単位で1文字に相当するため、「！」「？」は全角で表記し、「!?」「!!」は半角で表記します。 +{} ## 見出しでは句点（。）を省略する ### 説明 -見出し（Heading）では、「。」は省略します。 +見出し（Heading）では、「。」は省略します。 同様に、例を示した場合の、名詞や「など」の後ろでは句点はつけません。 UIテキストでは、それぞれのコンポーネントごとのルールを参照してください。 ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1605150202129600 +{} ## 箇条書きの場合の句点（。）の使い分け ### 説明 - -単語を箇条書きにする場合は、「。」を省略します。 +単語を箇条書きにする場合は、「。」を省略します。 文章を箇条書きにする場合は、「。」をつけます。 ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1691645627079309 +{} ## 複数の語句を列挙する場合の、読点（、）とナカグロ（・）の使い分け ### 説明 -列挙の順序に意味があるときは、「、」を使用します。 +列挙の順序に意味があるときは、「、」を使用します。 順序を入れ替えても構わないときは、「・」を使用します。 ### 使い分け例 -信号は青、黄、赤の順に点灯する。 +信号は青、黄、赤の順に点灯する。 信号には青・黄・赤の三色がある。 ### 具体例 -被保険者整理番号、マイナンバー、基礎年金番号のいずれかが必要です。 +被保険者整理番号、マイナンバー、基礎年金番号のいずれかが必要です。 ※上記は、CSV形式の算定基礎届を取り込んだ際のエラーメッセージ。CSVの項目（列）を入れ替えできないので「、」を使用。 ### 出典 @@ -51,101 +52,92 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1691645627079309 数学文章作法 基礎編の「2.4語句」 {/* textlint-enable */} +{} ## 数字と英単語の前後に半角スペースを挿入しない ### 説明 - 和欧混植の文章内の英単語と、数字の前後には半角スペースは入れずに詰めましょう。 ### 例 - OK：PDFファイルをアップロード NG：PDF ファイルをアップロード OK：2020年の年末調整 NG：2020 年の年末調整 +{} ## 記述記号は全角を使用し、前後にスペースは入れない ### 説明 記述記号は基本的に全角を使用し記号の前後にスペースは挿入しません。英数字とあわせて表記する場合のみ半角を使用します。 -記述記号とは、以下を指します。 -- 区切り符　`・`（中点、ナカグロ）、`｜`（バーティカルバー、パイプ）、`：`（コロン）、`／`（スラッシュ） -- 句読点　`、`（読点）、`。`（句点） -- 括弧類　`（ ）`、`「 」` 、`［ ］`、`【 】` -- つなぎ符　`― `（ダッシュ）、`…`（三点リーダー）、`〜`（波線） +記述記号とは、以下を指します。 +- 区切り符　`・`（中点、ナカグロ）、`｜`（バーティカルバー、パイプ）、`：`（コロン）、`／`（スラッシュ） +- 句読点　`、`（読点）、`。`（句点） +- 括弧類　`（ ）`、`「 」` 、`［ ］`、`【 】` +- つなぎ符　`― `（ダッシュ）、`…`（三点リーダー）、`〜`（波線） - `？`（疑問符）、`！`（感嘆符） 例外として、**数値の3桁ごとに使用するカンマ（ , ）、階層構造を表す際の区切り符（ / ，>）、変数を表す波括弧（\{ \}）は半角**を使用します。 ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1643955700509219 +{} ## 括弧類は「 」、［ ］、【 】、（ ）を使用する ### 説明 - 文章における強調は鉤括弧`「 」`もしくは隅付き括弧`【 】`を使用し、引用符`“ ”` や二重かぎ括弧 `『 』`は使用しません。 補足は丸括弧`（ ）`を使用します。丸括弧に限り、全文英語のプレスリリースやWovnでの翻訳結果で半角`( )`を使用します。 +{} ## 括弧「 」、［ ］、【 】の使い分け ### 説明 - アプリケーション上での括弧の使い分けは以下です。 ヘルプページやリリースノートも準じます。 #### 鉤括弧`「 」` - - ファイル名を示すのに用います。 -- フォームなどにユーザーが入力する文字列や値を示すのに用います。 +- フォームなどにユーザーが入力する文字列や値を示すのに用います。 - 例：`「1000」と入力します。` -- 文や単語を強調したいときに用います。 +- 文や単語を強調したいときに用います。 - 例：`スキル管理機能には、「機能管理者」、「業務担当者」の2種類の管理者権限があります。` -- 地の文と区別したい文や単語に用います。 +- 地の文と区別したい文や単語に用います。 - 例：`データを更新して、SmartHR基本機能と同じ状態にすることを「データを同期する」と言います。` #### 角括弧`［ ］` - -- 設定項目名、タブ名、操作ボタン名、選択肢などに用います。なお、画面名には`［ ］`をつけません。 - - 例：`パスワードを入力して［登録する］を押します。` +- 設定項目名、タブ名、操作ボタン名、選択肢などに用います。なお、画面名には`［ ］`をつけません。 + - 例：`パスワードを入力して［登録する］を押します。` - 例：`マイナンバー管理画面に移動します。` #### 隅付き括弧`【 】` - -- ユーザーが独自に命名するオブジェクト名に用います。 +- ユーザーが独自に命名するオブジェクト名に用います。 - 例：`【2023年上期評価】を削除します。` ### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1695364655322429 +{} ## 三点リーダー（…）は1つでOK - ### 説明 - 紙の場合、「…」を使用する場合は、2つで1セットとするのが通例とされていますが、ウェブなのであまり気にせず1つに統一とします。 +{} ## 変数は\{ \}を使用する - ### 説明 - -環境や設定によって値が変わる変数は、`{ }`を使用します。 - +環境や設定によって値が変わる変数は、`{ }`を使用します。 記述記号は全角を使用しますが、例外として、`{ }`は半角を使用します。 ### 例 \{会社名\}、\{サブドメイン\}.smarthr.jp ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1664497034945159 +{} ## 例を示すときには、コロン（：）を使用する - ### 説明 - ヒントメッセージなどで、例を示すときには「（ ）」ではなく、「：」を使いましょう。 括弧類は、左右を組み合わせて（両括弧）の使用が基本的な用法。右側のみ（片括弧）で使うことも間違いではないものの、学術論文や大学のレポートなどでの使用なので、SmartHRのヒントメッセージなどでは、両括弧を推奨とします。 @@ -153,5 +145,5 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1664497034945159 また、`例：`と`（例）`で比較すると、コロンを使用した方が少ない文字数に収められるので、「：」を使うことにしました。 ### 例 -OK：例：hogehoge -NG：（例）hogehoge、例）hogehoge、例: hogehoge +OK：例：hogehoge +NG：（例）hogehoge、例）hogehoge、例: hogehoge \ No newline at end of file diff --git a/src/content/articles/products/contents/idiomatic-usage/usage.mdx b/src/content/articles/products/contents/idiomatic-usage/usage.mdx index fb0ef7d27..dadeca784 100644 --- a/src/content/articles/products/contents/idiomatic-usage/usage.mdx +++ b/src/content/articles/products/contents/idiomatic-usage/usage.mdx @@ -6,6 +6,7 @@ ignoreH3Nav: true --- SmartHR独自の用語を定義しています。 +{} ## アプリケーションで最初に表示される画面は「ホーム」と表記し、「トップ」「トップページ」の使用は控える ### 説明 @@ -26,6 +27,7 @@ SmartHR独自の用語を定義しています。 - https://kufuinc.slack.com/archives/C01KY3WRX8Q/p1647337887984939?thread_ts=1647306156.369359&cid=C01KY3WRX8Q {/* textlint-disable */} +{} ## マスターデータの総称は「マスターデータ」、総称以外は「◯◯マスター」と表記する ### 説明 @@ -47,7 +49,8 @@ NG：マスター、システム標準マスターデータ、カスタムマス 意識させる必要がない場合：「〇〇マスター」 -意識させる必要があるが、「マスター」を繰り返すことで意味が伝わりづらくなる場合：「システム標準マスターの雇用形態」 ※「システム標準マスターの雇用形態マスター」とは表記しない +意識させる必要があるが、「マスター」を繰り返すことで意味が伝わりづらくなる場合：「システム標準マスターの雇用形態」 +※「システム標準マスターの雇用形態マスター」とは表記しない OK： マスターデータ > システム標準マスター > 雇用形態 NG： マスターデータ > システム標準マスター > 雇用形態マスター @@ -63,6 +66,7 @@ NG： マスターデータ > システム標準マスター > 雇用形態マ 決定経緯（長音をつける） : https://kufuinc.slack.com/archives/CJX59GJFR/p1599529484034300 +{} ## アプリケーションの呼び方には「SmartHR基本機能」と「オプション機能」を使用する ### 説明 @@ -70,7 +74,6 @@ NG： マスターデータ > システム標準マスター > 雇用形態マ 加えて、「プラスアプリ」と呼ばれている機能は、「SmartHRオプション機能」とします。具体的には、年末調整、カスタム社員名簿、文書配付、分析レポート、従業員サーベイ、組織図、人事評価、配置シミュレーションを指します。 -{/* textlint-enable */} ### 例外 SmartHRであることが明らかにわかる文脈では「基本機能」「オプション機能」としても構いません。 @@ -78,6 +81,7 @@ SmartHRであることが明らかにわかる文脈では「基本機能」「 文中では、初出時に「SmartHR基本機能」と記載し、以降は「基本機能」として、SmartHRを省略可能です。 +{} ## ユーザーを示す言葉は「お客さま」「管理者さま」「担当者さま」「ユーザーさま」を使い分ける ### 説明 ユーザーを示す言葉は、以下の基準で使い分けます。 @@ -87,40 +91,44 @@ SmartHRであることが明らかにわかる文脈では「基本機能」「 - 担当者さま： 「人事労務の担当者さま」などと言う場合のみ使用します。「ご担当者さま」としても構いません。 - ユーザーさま： SmartHRのすべての利用者、つまり管理者と従業員の両方を含めて呼びたいときに使用します。 +{} ## 管理者の呼称は、基本機能とオプション機能の区別がわかるように表記する ### 説明 -{/* textlint-disable */} 通称「SmartHR本体」とされているアプリケーションの呼称を「SmartHR基本機能」に統一したことに伴い、管理者の呼称は「SmartHR管理者」ではなく「SmartHR基本機能の管理者」とします。 同様に「SmartHRオプション機能」の管理者の呼称は「◯◯機能管理者」など、各機能で定められた呼称を使用します。 -{/* textlint-enable */} ### 例外 「SmartHR基本機能の管理者」は、初出でない場合は「基本機能管理者」としても構いません。 +{} ## 従業員の休職や退職を表すステータスの総称は「在籍状況」と表記し、勤務中の状態は「在職中」と表記する ### 説明 -{/* textlint-disable */} 従業員の休職や退職を表すステータスは、「在籍状況」と表記します。「在職状況」は使用しません。 在籍状況には、「在職中」、「休職中」、「退職済み」の3つのステータスがあります。 ステータスの中で、勤務に従事している状態は「在職中」と表記します。「在籍中」は使用しません。 -理由 休職中にも会社に籍はあるので、「在籍中」という表記には休職中も含むことになる。 +理由 +休職中にも会社に籍はあるので、「在籍中」という表記には休職中も含むことになる。 在職中と休職中の両方を指したい場合は「在籍中」を使っても構いません。 + ### 議事録 https://smarthr-inc.docbase.io/posts/2183600 +{} ## 企業ごとに作成するアカウントの呼び方には「企業アカウント」を使用する ### 説明 企業ごとに作成するアカウントの呼び方には「企業アカウント」を使用します。「テナント」は社内用語のため、使いません。 +{} ## 「文書配付」と表記し、「文書配布」と表記しない。 ### 説明 -「配布 」には同一の文書を広く配るという意味があります。一方「配付」には個人宛の書類を配る という意味があります。文書配付昨日は従業員に個別の書類を送る機能であるため、「文書配付」機能という表記を使用します。 +「配布 」には同一の文書を広く配るという意味があります。一方「配付」には個人宛の書類を配る という意味があります。文書配付機能は従業員に個別の書類を送る機能であるため、「文書配付」機能という表記を使用します。 +{} ## 「健康保険組合」と表記し、「健保組合」「組合健保」の使用は控える ### 説明 略称を使わず、「健康保険組合」で統一します。 @@ -128,19 +136,19 @@ https://smarthr-inc.docbase.io/posts/2183600 #### 議事録 https://kufuinc.slack.com/archives/CJX59GJFR/p1692751084332699 +{} ## AppNaviは「［｛機能名｝］メニュー」と表記する ### 説明 - AppNaviは「［｛機能名｝］メニュー」と表記します。機能名の部分は角括弧`［ ］`で囲います。 ### 例 OK例：**［届出書類］メニュー**にある **［電子申請］** を押すと、電子申請一覧が表示されます。 ### 議事録 - - https://kufuinc.slack.com/archives/CJX59GJFR/p1717730523908459 +{} ## 「扶養する家族」「扶養しない家族」と表記し、「扶養家族」の使用は控える ### 説明 diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index e0b4c8481..2d9ac10a5 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -61,7 +61,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 変更点が複数ある場合は、ユーザーへの影響が一番大きい見出しをリリースノートのタイトルにします。 不具合修正の変更しかない場合は、`不具合○件を修正しました`と記載します。 -タイトルでは、句点を省略します。[見出しでは句点（。）を省略する](/products/contents/idiomatic-usage/symbol/#h2-1) +タイトルでは、句点を省略します。[見出しでは句点（。）を省略する](/products/contents/idiomatic-usage/symbol/#omit-period-in-headings) 例： {/* textlint-disable */} @@ -80,7 +80,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 変更点の概要を伝えます。見出しは、ユーザーが本文を確認すべきかどうかの判断材料になります。 見出しは20文字程度を目安とし、ひと目で読み切れる文字数に収めます。文字数が少なすぎると正確性を損なうため、文字数を減らすよりも、誤解を生まないことを優先します。 -また、句点を省略します。[見出しでは句点（。）を省略する](/products/contents/idiomatic-usage/symbol/#h2-1) +また、句点を省略します。[見出しでは句点（。）を省略する](/products/contents/idiomatic-usage/symbol/#omit-period-in-headings) ユーザーが理解しやすいよう、業務や操作時の認知から想起しやすい言葉を使って書きます。 後述する本文（③ユーザーにとって変わったこと）のサマリーだと考えましょう。 diff --git a/src/content/articles/products/contents/ui-text/app-writing.mdx b/src/content/articles/products/contents/ui-text/app-writing.mdx index e8b75aec6..8242510f3 100644 --- a/src/content/articles/products/contents/ui-text/app-writing.mdx +++ b/src/content/articles/products/contents/ui-text/app-writing.mdx @@ -7,6 +7,7 @@ ignoreH3Nav: true アプリケーション上の表現で迷ったときの判断基準や、推奨する表記を記載しています。 +{} ## ディスクリプションは敬体（です、ます調）を用いて、動詞まで書く ### 説明 @@ -16,6 +17,7 @@ ignoreH3Nav: true 画面ごとのライティングの詳細は、デザインパターンで確認してください。 +{} ## ボタンラベルには動詞の終止形を使用する ### 説明と例 @@ -36,6 +38,7 @@ NG例：「追加する」「削除する」 OK例：権限を追加、申請を取り消す NG例：権限の追加、申請の取り消し +{} ## 画面タイトルや項目名には名詞を使用する ### 説明 @@ -49,18 +52,21 @@ NG例：権限の追加、申請の取り消し OK例：権限の追加、申請の取り消し NG例：権限を追加、申請を取り消す +画面ごとのライティングの詳細は、デザインパターンで確認してください。 + +{} ## 移動の操作を表すときの助詞は、具体的な対象なら「に」、相対的な位置なら「へ」 ### 説明 -移動の操作を書く場合、可能な限り場所を明示し「に」を伴います。 +移動の操作を書く場合、可能な限り場所を明示し「に」を伴います。 ただし、省略する場合は、相対的な位置で示して「へ」を伴います。 ［○○］（画面名）や［〇〇一覧］といった具体的な場所を指す場合は「に」を使用します。 #### 例 -OK：「一覧に戻る」、 「従業員リストに戻る」 +OK：「一覧に戻る」、「従業員リストに戻る」 NG：「一覧へ戻る」 前後左右といった相対的な位置を指す場合は「へ」を使用します。 @@ -71,9 +77,9 @@ OK：「前へ」、「前へ戻る」 NG：「前に戻る」 ### 議事録 - https://smarthr-inc.docbase.io/posts/1719994 +{} ## テキストリンクは「こちら」ではなく、移動先を想起しやすい表現をする ### 説明 @@ -83,27 +89,27 @@ https://smarthr-inc.docbase.io/posts/1719994 ただし、文字数に制限がある場合は「ヘルプを参照する」などの表現をして構いません。 #### 関連ルール -[ヘルプページへの動線](https://smarthr.design/products/contents/ui-text/help-link/) +[ヘルプページへの動線](/products/contents/ui-text/help-link/) #### 参考文献 [Web Content Accessibility Guidelines - 2.4.4 リンクの目的（コンテキスト内）を理解する](https://waic.jp/translations/WCAG21/Understanding/link-purpose-in-context.html) ### 議事録 - https://smarthr-inc.docbase.io/posts/1308637#%E3%83%AA%E3%83%B3%E3%82%AF +{} ## よくあるテーブルの見出しに「一覧」はつけない ### 説明 -[よくあるテーブル](https://smarthr.design/products/design-patterns/smarthr-table/)のような表形式の一覧表示の見出しでは、「一覧」を省略します。 +[よくあるテーブル](/products/design-patterns/smarthr-table/)のような表形式の一覧表示の見出しでは、「一覧」を省略します。 同様に、メインオブジェクトが一覧の画面タイトルも同様に「一覧」を省略します。 ただし、機能名とオブジェクト名が一致する場合は、同じ画面内でコンテンツを区別するために「一覧」をつけてください。 #### 例：申請機能 -- 申請機能の画面タイトルは「申請」 +- 申請機能の画面タイトルは「申請」 - 申請を一覧表示するテーブルの見出しは「申請一覧」 [「上階層に戻る」リンク](/products/components/text-link/upward-link/)の場合は、戻る画面を具体的に伝えるために「〇〇一覧に戻る」の表記とします。簡潔な言い回しにするため、「〜の一覧」のように「の」はつけません。 @@ -113,6 +119,7 @@ https://smarthr-inc.docbase.io/posts/1308637#%E3%83%AA%E3%83%B3%E3%82%AF 見出しについては、一覧であることが明白なので必要ないと判断。 前の画面をより具体的に伝えるために、戻るリンクには「〇〇一覧」の表記にした方が良いと考えました。 +{} ## ページタイトルは、機能名とSmartHRをバーティカルバー（｜）でつなぐ ### 説明 @@ -126,9 +133,9 @@ https://smarthr-inc.docbase.io/posts/1308637#%E3%83%AA%E3%83%B3%E3%82%AF - 組織図｜SmartHR（スマートHR） ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1631164443066500 +{} ## ユーザー名、アカウントの表記方法 ### 説明 @@ -143,6 +150,7 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1631164443066500 - 新しい従業員の育児休暇申請 {/* textlint-enable */} +{} ## 複製したオブジェクトは、オブジェクト名の頭に（コピー）をつける ### 説明 @@ -155,12 +163,12 @@ https://kufuinc.slack.com/archives/CJX59GJFR/p1631164443066500 ファイル名の末尾に「のコピー」などを追加していくと、一覧表示での視認性が悪くなるほか、長いオブジェクト名の場合にコピーであることに気がつきにくいため、プレフィクスをつけることにしました。 ### 議事録 - https://kufuinc.slack.com/archives/CJX59GJFR/p1643274254069400 +{} ## Tooltipのライティング ### 説明 - 文章は、簡潔なテキストになるよう心がけてください。 - 1文のみの場合でも、文章には句点をつけます。 -- 単語/ラベルのみの場合は句点を省略します。 +- 単語/ラベルのみの場合は句点を省略します。 \ No newline at end of file diff --git a/src/content/articles/products/contents/ui-text/error-messages.mdx b/src/content/articles/products/contents/ui-text/error-messages.mdx index 6a93486d8..68b6cb8f3 100644 --- a/src/content/articles/products/contents/ui-text/error-messages.mdx +++ b/src/content/articles/products/contents/ui-text/error-messages.mdx @@ -6,22 +6,25 @@ order: 1 アプリケーション内に表示するエラーメッセージの作成に関するガイドラインです。 -エラーメッセージのライティングは、[基本的な考え方](/products/contents/writing-style/)、[用字用語](/products/contents/idiomatic-usage/)に準拠します。 +エラーメッセージのライティングは、[基本的な考え方](/products/contents/writing-style/)、[用字用語](/products/contents/idiomatic-usage/)に準拠します。 そのほか、エラーメッセージ特有の気をつけるべきポイントを記載しています。 +{} ## 適用範囲 アプリケーションを操作してエラーが発生したときに表示するメッセージすべてです。 -ここでは、以下の場合について説明します。 -* バックグラウンド処理画面 +ここでは、以下の場合について説明します。 +* バックグラウンド処理画面 * FlashMessage +{} ## エラーメッセージの基本的な考え方 エラーメッセージを表示する目的は、**ユーザーがメッセージを見て問題を解決でき、次の操作に進める**状態にすることです。 -この状態を実現できないエラーメッセージだった場合、ユーザーの戸惑いや不安につながります。 +この状態を実現できないエラーメッセージだった場合、ユーザーの戸惑いや不安につながります。 ユーザーが問題を解決できる対処方法を明示した内容にすることを考えます。 +{} ## エラーメッセージの基本的な要素 どのエラーメッセージであっても、含める情報の要素は**事象・原因・対処**です。 @@ -41,11 +44,13 @@ order: 1 スペースが足りないときなど、すべての要素を表示できない場合は、**原因＞対処＞事象**の順で優先しましょう。 -ユーザーの目的は「無事に操作を完了させること」であり、そのためにユーザーが知りたいことは「どうしたらエラーを解消できるか」です。 +ユーザーの目的は「無事に操作を完了させること」であり、そのためにユーザーが知りたいことは「どうしたらエラーを解消できるか」です。 そのため、エラーを解消するための原因とその対処の表示を優先します。 +{} ## エラーメッセージのライティングパターン +{} ### バックグラウンド処理 * バックグラウンド処理のエラーメッセージに含める要素は、**事象・原因・対処**です。 * フラッシュメッセージと異なり、メッセージを表示するスペースがあるため、すべての要素を記載しましょう。 @@ -68,7 +73,7 @@ order: 1 エラー詳細 「CSVファイルの文字コードが不正な形式です。」 -* 結果概要とエラー詳細に同じ内容が記載されており、詳細を確認しようとしたユーザーが詳しい情報得られない内容になっています。 +* 結果概要とエラー詳細に同じ内容が記載されており、詳細を確認しようとしたユーザーが詳しい情報を得られない内容になっています。 * 結果概要に操作が失敗した**原因**が記載され、ユーザーの操作「CSVファイルの取り込み」の結果が記載されていません。 * 具体的な**対処**が記載されておらず、エラーをどう解消すればいいのかがわからない内容になっています。 @@ -80,7 +85,7 @@ order: 1 例：CSVを取り込んで、従業員を一括招待する 2. ユーザーが実行する操作と目的の操作が一致している場合 - + 例：PDFを一括でアップロードする ##### 1. CSVを取り込むことで、目的の操作をする場合 @@ -89,8 +94,9 @@ order: 1 ##### 2. 目的となる操作とユーザーが実行する操作が一致している場合 +{} ### FlashMessage -* [FlashMessage](https://smarthr.design/products/components/flash-message/)で伝える要素は、**原因**または**原因・対処**です。 +* [FlashMessage](/products/components/flash-message/)で伝える要素は、**原因**または**原因・対処**です。 * FlashMessageは数秒で消えてしまい、かつメッセージの表示スペースが少ないため、ユーザーがひと目で把握できる情報量にする必要があります。 #### OK例 @@ -105,6 +111,5 @@ order: 1 * **事象・原因・対処**のすべてに言及し、親切そうではありますが、情報量が多く、数秒で消えてしまうFlashMessageには適しません。 * **原因**の「対象のカスタムマスター項目は、存在しません。」は事実ではありますが、「なぜ存在しないのか（＝すでに削除されているから）」が説明されていません。 - #### ライティングパターン - + \ No newline at end of file diff --git a/src/content/articles/products/contents/ui-text/help-link.mdx b/src/content/articles/products/contents/ui-text/help-link.mdx index fd70763c9..0e233dbad 100644 --- a/src/content/articles/products/contents/ui-text/help-link.mdx +++ b/src/content/articles/products/contents/ui-text/help-link.mdx @@ -28,7 +28,7 @@ import { FaExternalLinkAltIcon, FaQuestionCircleIcon } from 'smarthr-ui' - ユーザーに求める動作は **「確認」ではなく「参照」** とします。 - アプリケーション内の確認を求める場合と書き分けることで、アプリケーション外であることを表現します。 - スペースに限りがある場合には、テキスト部分は省略して構いません。 - - [テキストリンクは「こちら」ではなく、移動先を想起しやすい表現をする](/products/contents/ui-text/app-writing/#h2-5) + - [テキストリンクは「こちら」ではなく、移動先を想起しやすい表現をする](/products/contents/ui-text/app-writing/#avoid-kocchira-use-in-descriptive-links) ### テキストリンク - テキストは、移動先ヘルプページのタイトルを基本とし、**括弧で囲みません。** diff --git a/src/content/articles/products/contents/ui-text/mail.mdx b/src/content/articles/products/contents/ui-text/mail.mdx index 206797fbd..4c6631f44 100644 --- a/src/content/articles/products/contents/ui-text/mail.mdx +++ b/src/content/articles/products/contents/ui-text/mail.mdx @@ -74,7 +74,7 @@ order: 3 3. URLへの誘導文も、**リンク先の画面で「何をしてほしいか」を伝える**ことを意識します。 *「URLにアクセスしてください」*では、画面を表示することしかユーザーに伝わりません。 - また、基本的な考え方[「カタカナ語を用いるときには、まず漢字語での言い換えを検討する」](https://smarthr.design/products/contents/writing-style/#rec2dXhsgUwiy472Q-0)の観点からも、 **アクセス**は控えたい表現です。 + また、基本的な考え方[「カタカナ語を用いるときには、まず漢字語での言い換えを検討する」](/products/contents/writing-style/#prefer-kanji-to-katakana-words)の観点からも、 **アクセス**は控えたい表現です。 * 例えば、 diff --git a/src/content/articles/products/contents/writing-style.mdx b/src/content/articles/products/contents/writing-style.mdx index 776cdec79..5033c5bfc 100644 --- a/src/content/articles/products/contents/writing-style.mdx +++ b/src/content/articles/products/contents/writing-style.mdx @@ -7,6 +7,7 @@ ignoreH3Nav: true 言葉をデザインするときの基本的な考え方をトピックごとに記載しています。 +{} ## 冗長な日本語を避ける ### 説明 @@ -26,6 +27,7 @@ NG：◯◯させていただきました。 https://smarthr-inc.docbase.io/posts/1304668 +{} ## 正しい文法表現を使用する ### 説明 @@ -39,6 +41,7 @@ https://smarthr-inc.docbase.io/posts/1304668 https://smarthr-inc.docbase.io/posts/1304668 +{} ## 常用漢字表にない読み方は使用しない ### 説明 @@ -58,13 +61,14 @@ https://smarthr-inc.docbase.io/posts/1304668 https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kakuki/14/pdf/jyouyou_kanjihyou.pdf +{} ## 平仮名にしたほうが読みやすい漢字は平仮名にする ### 説明 漢字より平仮名にしたほうが読みやすかったり、普段から平仮名のほうが馴染みがあったりする場合は、平仮名を用いて、[SmartHRのパーソナリティ](https://smarthr.design/foundation/#h2-0)（誠実・ポジティブ・わかりやすい・親しみやすい）を表現します。 -一方で、平仮名にしすぎないように注意しましょう。 +一方で、平仮名にしすぎないように注意しましょう。 平仮名にしすぎると、当てはまる漢字が何かを判断する手間が頻繁に発生し、ユーザーに読解の負荷をかけてしまいます。 ### 出典 @@ -73,6 +77,7 @@ https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kakuki/14/pdf/jyouyou_ka https://coliss.com/articles/build-websites/operations/notational-convention-for-writing.html +{} ## カタカナ語を用いるときには、まず漢字語での言い換えを検討する ### 説明 @@ -85,6 +90,7 @@ https://coliss.com/articles/build-websites/operations/notational-convention-for- https://kufuinc.slack.com/archives/CJX59GJFR/p1640660708293300?thread_ts=1638318584.218500&cid=CJX59GJFR +{} ## 敬語を使いすぎない ### 説明 @@ -103,6 +109,7 @@ NG：◯◯させていただきました。 https://www.keigoryoku.com/keigo/ +{} ## 同じことを複数の表現で説明しないようにする ### 説明 @@ -111,6 +118,7 @@ https://www.keigoryoku.com/keigo/ ただし、ヘルプページなどでユーザーの理解を促すための言い換えに伴う別の表現は、意図的なものなのでその限りではありません。 +{} ## 格助詞をむやみに省略しない ### 説明 @@ -125,15 +133,18 @@ NG：項目名変更します。 OK：操作が完了したら〜 NG：操作完了したら〜 +{} ## 社内用語など、一般的でない言葉を使わない ### 説明 -どのようなユーザーにも伝わりやすいように、辞書に載っている一般的な言葉を使いましょう。 +どのようなユーザーにも伝わりやすいように、辞書に載っている一般的な言葉を使いましょう。 社内用語・専門用語・独自の用語など、ユーザーに伝わらない可能性がある言葉は避けましょう。 + {/* textlint-disable */} #### 例 -OK： 企業アカウント +OK： 企業アカウント NG： テナント {/* textlint-enable */} + ### 議事録 -https://kufuinc.slack.com/archives/CJX59GJFR/p1652166634163919 +https://kufuinc.slack.com/archives/CJX59GJFR/p1652166634163919 \ No newline at end of file From d7c00dc53d380b59de3d3feeba3c46abc5c823d0 Mon Sep 17 00:00:00 2001 From: kuvanov Date: Tue, 7 Jan 2025 19:47:05 +0900 Subject: [PATCH 2/2] =?UTF-8?q?=E3=83=A9=E3=82=A4=E3=83=86=E3=82=A3?= =?UTF-8?q?=E3=83=B3=E3=82=B0>UI=E3=83=86=E3=82=AD=E3=82=B9=E3=83=88>?= =?UTF-8?q?=E3=82=A8=E3=83=A9=E3=83=BC=E3=83=A1=E3=83=83=E3=82=BB=E3=83=BC?= =?UTF-8?q?=E3=82=B8=E3=81=AE=E5=86=85=E5=AE=B9=E3=82=92FlashMessage?= =?UTF-8?q?=E3=81=8B=E3=82=89NotificationBar=E3=81=AB=E5=A4=89=E6=9B=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../products/contents/ui-text/error-messages.mdx | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/content/articles/products/contents/ui-text/error-messages.mdx b/src/content/articles/products/contents/ui-text/error-messages.mdx index 68b6cb8f3..e60eff31f 100644 --- a/src/content/articles/products/contents/ui-text/error-messages.mdx +++ b/src/content/articles/products/contents/ui-text/error-messages.mdx @@ -15,7 +15,8 @@ order: 1 ここでは、以下の場合について説明します。 * バックグラウンド処理画面 -* FlashMessage +* [NotificationBar](/products/components/notification-bar/) + {} ## エラーメッセージの基本的な考え方 @@ -94,10 +95,10 @@ order: 1 ##### 2. 目的となる操作とユーザーが実行する操作が一致している場合 -{} -### FlashMessage -* [FlashMessage](/products/components/flash-message/)で伝える要素は、**原因**または**原因・対処**です。 -* FlashMessageは数秒で消えてしまい、かつメッセージの表示スペースが少ないため、ユーザーがひと目で把握できる情報量にする必要があります。 +{} +### NotificationBar +* [NotificationBar](/products/components/notification-bar/)で伝える要素は、**原因**または**原因・対処**です。 +* NotificationBarはメッセージの表示スペースが少ないため、ユーザーがひと目で把握できる情報量にする必要があります。 #### OK例 「対象のカスタムマスター項目は、すでに削除済みです。」 @@ -108,8 +109,8 @@ order: 1 #### NG例 「対象のカスタムマスター項目の削除に失敗しました。対象のカスタムマスター項目は、存在しません。対象のカスタムマスター項目を確認してください。」 -* **事象・原因・対処**のすべてに言及し、親切そうではありますが、情報量が多く、数秒で消えてしまうFlashMessageには適しません。 +* **事象・原因・対処**のすべてに言及し、親切そうではありますが、情報量が多く、1行程度の表示推奨されるNotificationBarには適しません。 * **原因**の「対象のカスタムマスター項目は、存在しません。」は事実ではありますが、「なぜ存在しないのか（＝すでに削除されているから）」が説明されていません。 #### ライティングパターン - \ No newline at end of file +