基本的な考え方や表記

このページに記載しているガイドラインは随時更新していきます。最新のガイドラインは、このページで確認してください。記載内容に気になる点がある場合は #productside_文言相談 チャンネル、または、お近くのUXライターまでお声がけください。

用字用語は、用字用語:一覧から確認してください。

冗長な日本語を避ける

説明

ユーザーに簡潔明瞭に伝えるため、「することができる」などの冗長な表現は極力使わない。 例: 使用することができます → 使用できます 管理が行えます/管理することができます → 管理できます

議論

https://smarthr-inc.docbase.io/posts/1304668

出典

-

正しい文法表現を使用する

説明

普段使用したことのある表現であったとしても、文法的に誤っていないかを確認して使用する。 例: 「ご参考ください」という表現は誤り。「ご◯◯ください」は「ご利用ください」など、「◯◯する」と言い換えられるときに使う(参考する、とは言い換えられないのでNG)。

議論

https://smarthr-inc.docbase.io/posts/1304668

出典

-

敬語を使いすぎない

説明

敬語によって情報が伝わりづらくならないようにする。 例: OK:◯◯を確認してください。 NG:◯◯をご確認いただけますようお願いいたします。 OK:◯◯しました。 NG:◯◯させていただきました。

議論

-

出典

https://www.keigoryoku.com/keigo/

同じことを複数の表現で説明しないようにする

説明

同じ単語や言い回しがないか、表記ゆれがないかを確認する。

議論

-

出典

-

機能や項目の説明文は敬体(です、ます調)で記載し、体言止めにしない。

説明

ただし、ボタン名や項目名などは体言止めで構わない。デザインシステムの設計ガイドを参考に記載する。 ◯:この画面では、部署を登録、管理できます。 ×:部署を登録、管理する画面。

議論

-

出典

-

句点(。)の使い方

説明

・1文のみの場合でも、文章には句点をつける。ただし、見出し(Heading)、ボタンのラベルについては、それぞれの書き方のルールに従い句点はつけない。フラッシュメッセージも同様で、1文の場合でも最後に「。」を付ける。 ・単語のみ/体言止めは句点なし。この場合、「など」で終わるものも含む。 なお、年末調整機能の依頼一覧にある「書類作成状況」の文章は以下理由で準拠していない。 ・ステータスのように表示している文章であること。 ・依頼一覧のすべてに「。」をつけると冗長になると判断。 https://kufuinc.slack.com/archives/C01L7GK9APK/p1615875069039500?thread_ts=1615874820.038500&cid=C01L7GK9APK ・フラッシュメッセージ単独で句点に関するルールがあったが、適用範囲を拡張した(2020/11/12)。

議論

https://kufuinc.slack.com/archives/CJX59GJFR/p1605150202129600

出典

-

常用漢字表にない読み方は基本的に使用しない

説明

常用漢字表に漢字としての掲載はあるが、読み方は掲載されていないケースがある。そのような漢字は、プロダクト内では使わない。 ただし、マーケティング側の文言と合わせた方がSmartHRとして統一性が出せる場合は、使用は許容する(個別判断)。 ✕:想い (「思い」を使う) ✕:旧い (「古い」を使う) 常用漢字表にない読み方を「表外読み」と呼ぶ。

議論

-

出典

文科省の常用漢字一覧表 https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kakuki/14/pdf/jyouyou_kanjihyou.pdf

遷移先がわかるようにリンクを記載する

説明

遷移先にどのような情報があるかがわかるようにリンクを記載する。「◯◯はこちら」など、「こちら」をクリックしないと、その先の情報がわからないような記載は使用しないこと。 表示の文字数に制限がある場合は、「詳しく見る」などを使用する。

議論

https://smarthr-inc.docbase.io/posts/1308637#%E3%83%AA%E3%83%B3%E3%82%AF

出典

-

Title に「一覧」はつけない

説明

「〇〇一覧」と Title に「一覧」はつけない。HTMLタイトルの表記も同様とする。 ただし、戻るリンクには「〇〇一覧に戻る」の表記で統一する。なお、 簡潔な言い回しにするため、「〜の一覧」のように「の」はつけない。

議論

前の画面をより具体的に伝えるために、戻るリンクには「〇〇一覧」の表記で良いと判断。Titleについては、一覧であることが明白なので必要ないと判断。

出典

-

ボタンは体言止めを基本とする

説明

体言止めにすると違和感があるなど、気になる場合は、#productside_文言相談チャンネルで相談してください。

議論

-

出典

-

アクションに関わるボタンやリンクは「を」で接続する

説明

最終的なアクションのボタンやリンクは「を」で接続して表記する。「の」はボタンやリンクでは使用しない(画面タイトルに使う)。 OK例:権限を追加、申請を取り消し NG例:権限の追加、申請の取り消し 理由は、「の」を使用した場合はアクションが動名詞になるため。ユーザーが押すボタンやリンクでは、アクションが動詞となる「を」を使用する方がより適切と判断する。

議論

https://smarthr-inc.docbase.io/posts/1512192

出典

-

アクションを伴う画面のタイトルは「の」で接続する

説明

アクションを伴う画面(新規作成画面、編集画面)やActionDialogのタイトルでは、アクションに関わる動詞(動名詞)は、基本的に「の」で接続して表記する。「を」はタイトルでは使用しない(ボタンやリンクに使う)。 OK例:権限の追加、申請の取り消し NG例:権限を追加、申請を取り消し

議論

-

出典

-

移動を表すときのオブジェクト名に付ける助詞

説明

[○○](画面名)や[〇〇一覧]といった具体的な場所を指す場合は「に」を使用する: OK例:「一覧に戻る」、 「従業員リストに戻る」 NG例:「一覧へ戻る」 前後左右といった相対的な位置を指す場合は「へ」を使用する: OK例:「前へ」、「前へ戻る」 NG例:「前に戻る」 移動先は画面が許す限り明示して、省略しない。省略する場合は相対的な位置で表現する。

議論

https://smarthr-inc.docbase.io/posts/1719994

出典

-

「SmartHR」の表記

説明

・プロダクト内、プロダクトに関わるコンテンツ(利用規約やヘルプページの場合)  SmartHR ・HTMLタイトル  {機能名}|SmartHR HTMLタイトルの例(パイプ「|」は全角で表記する) 文書配付|SmartHR 組織図|SmartHR

議論

https://kufuinc.slack.com/archives/CJX59GJFR/p1631164443066500

出典

-

バックグラウンド処理に関する文言は「{処理名}を受け付けました」にする

説明

バックグラウンド処理をリクエストした時のインフォメーションパネルの文言は「{処理名}を受け付けました」とする(「予約しました」にはしない)。 OK例:従業員情報のダウンロードを受け付けました。 NG例:従業員情報のダウンロードを予約しました。 NG例:申請の依頼を予約しました。

議論

https://kufuinc.slack.com/archives/CJX59GJFR/p1608001964454300 給与明細でCSV取り込み後のインフォメーションパネルの文言として、予約→受け付けに変更。

出典

-

オブジェクト(ファイル)をアップロード操作する際の文言

説明

選択時のアクションの名前: ファイルを選択 完了時のアクションの名前: 登録 一括登録/更新 一括更新 通知時のメッセージ: ファイルをアップロードしました。

議論

-

出典

-

ヘッダーの行も含めてエラーの発生した行数を表示する。

説明

バックグラウンド処理のエラー詳細で表示する行数は、ヘッダーの行も含めてエラーの発生した行数を表示する。 {n}行目:{エラー文言} そのため、nには2以上の数字が入る(なお、1行目はヘッダーになるため、nに1が入ることはない)。

議論

-

出典

-

プロダクト上からヘルプページをリンクする際の表記

説明

プロダクト上からヘルプセンターへ遷移する操作であることを、ユーザーが認識できるように表記する。 例: 詳しくは、{ヘルプページのタイトル} <i class="fa fa-external-link"></i> を参照してください。 {hoge}については、{ヘルプページのタイトル} <i class="fa fa-external-link"></i> を参照してください。 {hoge}の詳しい操作方法は、{ヘルプページのタイトル} <i class="fa fa-external-link"></i> を参照してください。 {hoge}や{fuga}、{piyo}については、{ヘルプページのタイトル} <i class="fa fa-external-link"></i> を参照してください。 ・ヘルプページのリンクテキストは、遷移先のヘルプページのタイトルを基本とし、約物では囲まない。スペースに制限がある場合には、短くリライトする。 ・現状、ヘルプセンターへの動線の表現に敬語表現が多く見られるが、他の操作文言と同様に敬語表現は過度に使用しない。 ・ユーザーに求める動作は 「確認」ではなく「参照」 とする。プロダクト上での確認を求める場合と書き分ける。

議論

https://smarthr-inc.docbase.io/posts/1938066 https://kufuinc.slack.com/archives/CJX59GJFR/p1622012612010600

出典

-

© 2021, SmartHR, Inc.