UIテキスト

アプリケーション上の表現で迷ったときの判断基準や、推奨する表記を記載しています。

ディスクリプションは敬体(です、ます調)を用いて、動詞まで書く

説明

アプリケーションにおけるディスクリプション(説明文)は、動詞まで記載します。体言止めは避けましょう。
なお、文体は敬体(です、ます調) を用います。

画面ごとのライティングの詳細は、デザインパターンで確認してください。

括弧「 」、[ ]、【 】の使い分け

説明

ライティングスタイル「括弧類は「 」、[ ]、【 】、( )を使用する」に準拠して準拠して、全角記号を使用します。

アプリケーション上での括弧の使い分けは以下です。
ヘルプページやリリースノートも準じます。

文中でファイル名を示すときに囲うもの

  • ファイル名:「 」
    地の文と区別したい
    強調したいとき

画面上の表示を示すときに囲うもの

  • 画面名 → [ ]
  • 設定項目名・タブ名 → [ ]
  • 操作ボタン名 → [ ]
  • 設定値(プルダウンの選択肢なども含む) → 「 」
  • カスタムオブジェクト名 → 【 】
    【 】は、以下のような場合に適宜使いましょう。
    注意して操作してほしいとき
    強調させたいとき
    ダイアログなどで操作手順を示すとき

日付と時間の表記

説明

日付(date)の文字列形式は、他社アプリケーションと連携しやすいよう、「YYYY/MM/DD」で表記します。

  • YYYY:西暦年4桁
  • MM:2桁の月
  • dd:2桁の日
    で表し、区切りには「/」を使用します。

時刻(time)の文字列形式は、HH:MMで表記します。

  • HH:24時間制の2桁
  • MM:2桁の分
    で表し、区切りには「:」を使用します。

アクションに関する画面やダイアログのタイトルでは、助詞は「の」を使用する

説明

操作画面やアクションダイアログで、オブジェクトを明記しながら操作を表す場合には、助詞に「の」を使用します。
削除ダイアログなどの一部を除き、タイトルには名前を示したいので、操作を動名詞として扱う「の」を伴います。

OK:権限の追加、申請の取り消し
NG:権限を追加、申請を取り消し

ボタンやテキストリンクでは、助詞は「を」を使用する

説明

ボタンのアクションテキストやリンクテキストでオブジェクトを明記する場合には、助詞に「を」使用します。
操作ボタンやリンクはユーザーの動作を表すので、操作を動詞として扱う「を」を伴います。

OK:権限を追加、申請を取り消し
NG:権限の追加、申請の取り消し

なお、画面タイトルは、操作を動名詞で表すという意図から「の」を使用します。

議事録

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

画面タイトル、項目名、ボタンは名詞、動名詞で表記する

説明

画面タイトル、項目名、ボタンに表示するアクションテキストは名詞、動名詞による表現を基本とし、オブジェクトを伴って動詞で書く場合には用言止めにします。

関連ルール
ボタンやテキストリンクでは、助詞は「を」を使用する

OK:取り込み、CSVを取り込む
NG:CSVを取り込み

画面ごとのライティングの詳細は、デザインパターンで確認してください。

移動の操作を表す時の助詞は、具体的な対象なら「に」、相対的な位置なら「へ」

説明

移動の操作を書く場合、可能な限り場所を明示し「に」を伴います。
ただし、省略する場合は、相対的な位置で示して「へ」を伴います。

[○○](画面名)や[〇〇一覧]といった具体的な場所を指す場合は「に」を使用します。

OK:「一覧に戻る」、 「従業員リストに戻る」
NG:「一覧へ戻る」

前後左右といった相対的な位置を指す場合は「へ」を使用します。

OK:「前へ」、「前へ戻る」
NG:「前に戻る」

議事録

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

テキストリンクは、移動先を想起しやすい表現をする

説明

テキストリンクを設置する場合には、移動先にどのような情報があるかを判断しやすいよう表現します。「詳細はこちら」などのリンク先を想起しづらい表現を避け、なるべく具体的な情報を記載しましょう。

ただし、文字数に制限がある場合は「ヘルプを参照する」などの表現をして構いません。

議事録

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

よくあるテーブルの見出しに「一覧」はつけない

説明

よくあるテーブルのような表形式の一覧表示の見出しでは、「一覧」を省略します。

同様に、メインオブジェクトが一覧の画面タイトルも同様に「一覧」を省略します。

ただし、機能名とオブジェクト名が一致する場合は、同じ画面内でコンテンツを区別するために「一覧」をつけてください。
例:申請機能

  • 申請機能の画面タイトルは「申請」
  • 申請を一覧表示するテーブルの見出しは「申請一覧」

「上階層に戻る」リンクの場合は、戻る画面を具体的に伝えるために「〇〇一覧に戻る」の表記とします。簡潔な言い回しにするため、「〜の一覧」のように「の」はつけません。

議事録

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

ページタイトルは、機能名とSmartHRをバーティカルバー(|)でつなぐ

説明

アプリケーション内、ヘルプセンター、利用規約、サービスサイトなどSmartHR全体を通して「SmartHR(スマートHR)」 という表記に統一します。

ページタイトルは、「{機能名}|SmartHR(スマートHR)」とします。

  • 文書配付|SmartHR(スマートHR)
  • 組織図|SmartHR(スマートHR)

議事録

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

ユーザー名、アカウントの表記方法

説明

社員番号と従業員氏名を併記する場合は、社員番号と氏名の間に半角スペースを挿入して、「{社員番号} {姓} {名}さんの{オブジェクト名}」のように書きます。

  • 0001 須磨 英子さんの育児休暇申請
  • 0001 eiko.suma@example.com の育児休暇申請
  • 0001 の育児休暇申請
  • 新しい従業員の育児休暇申請

例を示すときには、コロン(:)を使用する

説明

ヒントメッセージなどで、例を示すときには「( )」ではなく、「:」を使いましょう。

括弧類は、左右を組み合わせて(両括弧)の使用が基本的な用法。右側のみ(片括弧)で使うことも間違いではないものの、学術論文や大学のレポートなどでの使用なので、SmartHRのヒントメッセージなどでは、両括弧を推奨とします。

また、例:(例)で比較すると、コロンを使用した方が少ない文字数に収められるので、「:」を使うことにしました。


OK:例:hogehoge
NG:(例)hogehoge、例)hogehoge、例: hogehoge

関連ルール
記述記号は全角を使用し、前後にスペースは入れない

作成を表す言葉(登録・追加・作成の考え方)

説明

新しくオブジェクトを作る操作を表現する言葉は、言葉の意味を理解し、コンテキストに合わせて使い分けましょう。

登録

  • 登録とは、帳簿や原簿に記し載せること
  • 例:(従業員を)新規登録する、事業所の登録

追加

  • 追加とは、すでにあるものに、あとからさらに加えること
  • 例:(事業所に)雇用形態を追加する、(事業所に)部署を追加する、(従業員に)家族を追加する

作成

  • 作成とは、計画や書類、また文章などを作ること
  • 例:雇用契約書の作成、報告書を作成する

議事録

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

複製したオブジェクトは、オブジェクト名の頭に(コピー)をつける

説明

複製したオブジェクトの名前は、オブジェクト名の頭に(コピー)をつけます。

例(オブジェクト名が「hogehoge」の場合)

  • (コピー)hogehoge

ファイル名の末尾に「のコピー」などを追加していくと、一覧表示での視認性が悪くなるほか、長いオブジェクト名の場合にコピーであることに気がつきにくいため、プレフィクスをつけることにしました。

議事録

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

ファイルを取り込んで操作するときの文言

説明

一括登録など、CSVファイルを取り込んで操作する場合は、以下の通りの表現を用います。

ファイルを選択するときのボタンのアクションテキストは「ファイルを選択」

ファイルの取り込みを実行するときのボタンのアクションテキストは「一括{操作名}」 もしくは、「取り込み」、「CSVを取り込む」とします。

  • 一括登録
  • 一括更新
  • 取り込み
  • CSVを取り込む

関連ルール
画面タイトル、項目名、ボタンは名詞、動名詞で表記する
ボタンやテキストリンクでは、助詞は「を」を使用する

バックグラウンド処理をリクエスト時の文言は「{処理名}を受け付けました」

説明

バックグラウンド処理をリクエストしたときに表示する文言は、「{処理名}を受け付けました」とします。

OK:従業員情報のダウンロードを受け付けました。
NG:従業員情報のダウンロードを予約しました。

議事録

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

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

説明

バックグラウンド処理のエラー詳細で表示する行数は、ヘッダーの行も含めてエラーの発生した行数を表示します。

{n}行目:{エラー文言}

そのため、nには2以上の数字が入ります(なお、1行目はヘッダーになるため、nに1が入ることはない)。

「デフォルト」と「プリセット」の使い分け

説明

用途に合わせて使い分けましょう。

デフォルト

  • ユーザーによる設定がされていない初期の状態や値を指すときに使用する。システム側で値やデータが設定されているケースと、設定されていないケースの両方がある。

プリセット

  • あらかじめシステム側で設定されている状態を指すときに使用する。

使い分け例

  • デフォルト値
  • プリセットレポート

なお、「プリセット」はユーザーが使い慣れない言葉なので、機能名称などで用いることを基本とし、ディスクリプションやヘルプページなどで状態を説明する表現としての使用は避けましょう。

OK:データがあらかじめ用意されています。
NG:データがプリセットされています。

議事録

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