ライティングスタイル

言葉をデザインするときの判断基準や表記ルールをトピックごとに記載しています。

冗長な日本語を避ける

説明

ユーザーに簡潔明瞭に伝えるため、「することができる」などの冗長な表現は極力避けましょう。

例

OK：◯◯を確認してください。
NG：◯◯をご確認いただけますようお願いいたします。

OK：◯◯しました。
NG：◯◯させていただきました。

議事録

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

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

説明

使用したことのある表現であったとしても、文法的に誤っていないかを確認して使用しましょう。

例えば、メールや口頭で使用されることが多い「ご参考ください」という表現は文法的には誤りです。正しくは「ご参考にしてください」
「ご◯◯ください」は「ご利用ください」など、「◯◯する」と言い換えられるときに使用します。

議事録

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

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

説明

常用漢字表にない読み方を「表外読み（表外音訓）」と言います。常用漢字表に掲載されていても、表外読みをする場合は、アプリケーション上での使用は控えましょう。

ただし、マーケティングなどで使用している表現に揃えて、SmartHRとして統一したい場合はその限りではありません。

表外読みの例

想い　（「思い」を使う）
旧い　（「古い」を使う）

出典

文科省の常用漢字一覧表

https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kakuki/14/pdf/jyouyou_kanjihyou.pdf

平仮名にしたほうが読みやすい漢字は平仮名にする

説明

漢字より平仮名にしたほうが読みやすかったり、普段から平仮名のほうが馴染みがあったりする場合は、平仮名を用いて、SmartHRのパーソナリティ（誠実・ポジティブ・わかりやすい・親しみやすい）を表現します。

一方で、平仮名にしすぎないように注意しましょう。平仮名にしすぎると、当てはまる漢字が何かを判断する手間が頻繁に発生し、ユーザーに読解の負荷をかけてしまいます。

出典

ひらがなで書くべき漢字のまとめ：企業サイトで使用する「ひらく漢字」「ひらかない漢字」｜コリス

https://coliss.com/articles/build-websites/operations/notational-convention-for-writing.html

カタカナ語を用いるときには、まず漢字語での言い換えを検討する

説明

カタカナ語を一切使用しないことは現実的ではありませんが、安易に使用しないようにしましょう。

カタカナ語は、ユーザーごとに、慣れ・不慣れだけでなく、意味の定義の振れ幅が漢字語以上に大きいという傾向があります。意味の理解が不確かな言葉は、ユーザーのメンタルモデルによって、その時々で都合の良い解釈が生じやすいので、できる限りカタカナ語を使用せず、漢字語で表現します。

議事録

https://kufuinc.slack.com/archives/CJX59GJFR/p1640660708293300?thread_ts=1638318584.218500&cid=CJX59GJFR

敬語を使いすぎない

説明

敬語表現を多用して、情報が伝わりづらくならないように配慮しましょう。

例

OK：◯◯を確認してください。
NG：◯◯をご確認いただけますようお願いいたします。

OK：◯◯しました。
NG：◯◯させていただきました。

出典

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

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

説明

同じ意味のものを別の単語や言い回しで表現をするのは避け、用字用語に準拠した表現を使用しましょう。

ただし、ヘルプページなどでユーザーの理解を促すための言い換えに伴う別の表現は、意図的なものなのでその限りではありません。

句点（。）を省略する場合

説明

見出し（Heading）では、「。」は省略します。
同様に、例を示した場合の、名詞や「など」の後ろでは句点はつけません。

UIテキストでは、それぞれのコンポーネントごとのルールを参照してください。

議事録

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

箇条書きの場合の句点（。）の使い分け

説明

単語を箇条書きにする場合は、「。」を省略します。
文章を箇条書きにする場合は、「。」をつけます。

議事録

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

複数の語句を列挙する場合の、読点（、）とナカグロ（・）の使い分け

説明

列挙の順序に意味があるときは、「、」を使用します。順序を入れ替えても構わないときは、「・」を使用します。

使い分け例

信号は青、黄、赤の順に点灯する。
信号には青・黄・赤の三色がある。

具体例

被保険者整理番号、マイナンバー、基礎年金番号のいずれかが必要です。
※上記は、CSV形式の算定基礎届を取り込んだ際のエラーメッセージ。CSVの項目（列）を入れ替えできないので「、」を使用。

出典

数学文章作法基礎編の「2.4語句」

数字と英単語の前後に半角スペースを挿入しない

説明

和欧混植の文章内の英単語と、数字の前後には半角スペースは入れずに詰めましょう。

例

OK：PDFファイルをアップロード
NG：PDF ファイルをアップロード

OK：2020年の年末調整
NG：2020 年の年末調整

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

説明

記述記号は基本的に全角を使用し記号の前後にスペースは挿入しません。英数字とあわせて表記する場合のみ半角を使用します。

記述記号とは、以下を指します。

区切り符　・（中点、ナカグロ）、｜（バーティカルバー、パイプ）、：（コロン）、／（スラッシュ）
句読点　、（読点）、。（句点）
括弧類　（）、「」 、［］、【】
つなぎ符　― （ダッシュ）、…（三点リーダー）、〜（波線）
？（疑問符）、！（感嘆符）

例外として、数値の3桁ごとに使用するカンマ（ , ）、階層構造を表す際の区切り符（ / ，>）、変数を表す波括弧（{ }）は半角を使用します。

追加した項目を、従業員に閲覧・更新させたい場合、権限の設定が必要です。
同じ部署や、その上位部署に所属する従業員を承認者にしたいときに利用します。

大前提の条件、小前提の条件がある場合の例

従業員がマイナンバーを提供した場合でも、被扶養者のマイナンバーを［提出しない］と回答したときは［提供保留中］と表示されます。

プロダクト

ライティングスタイル