ライティングスタイル

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

冗長な日本語を避ける

説明

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


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

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

説明

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

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

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

出典

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

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

説明

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


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

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

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

説明

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

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

  • 区切り符 (中点、ナカグロ)、(バーティカルバー、パイプ)、(コロン)、(スラッシュ)
  • 句読点 (読点)、(句点)
  • 括弧類 ( )「 」[ ]【 】
  • つなぎ符 (ダッシュ)、(三点リーダー)
  • (疑問符)、(感嘆符)

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

関連する個別ルールは、以下を参照してください。
!と?は単独では全角、ペアで使う場合は半角
括弧類は「」、[]、【】を使用する
日付、時刻の形式

議事録

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

括弧類は「 」、[ ]、【 】、( )を使用する

説明

文章における強調は鉤括弧「 」もしくは隅付き括弧【 】を使用し、引用符“ ” や二重かぎ括弧 『 』は使用しません。
補足は丸括弧( )を使用します。丸括弧に限り、全文英語のプレスリリースやWovnでの翻訳結果で半角( )を使用します。

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

三点リーダー(…)は1つでOK

説明

紙の場合、「…」を使用する場合は、2つで1セットとするのが通例とされていますが、Webなのであまり気にせず1つに統一とします。

3桁以上の数値には、カンマ( , )を入れる

説明

読みやすさの観点から、3桁以上の数値を表記する場合は「,」を入れます。

また、カンマは数字に合わせて半角を用います。


1,000,000円、10,000人

議事録

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

変数は{ }を使用する

説明

環境や設定によって値が変わる変数は、{ }を使用します。

記述記号は全角を使用しますが、例外として、{ }は半角を使用します。


{会社名}、{サブドメイン}.smarthr.jp

議事録

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

格助詞をむやみに省略しない

説明

言葉同士の関係がわかりやすいように、「が」「の」「を」「に」「へ」「と」「より」「から」「で」などの格助詞は省略せずに記載しましょう。


OK:項目名を変更します。
NG:項目名変更します。

OK:操作が完了したら〜
NG:操作完了したら〜

ライティングスタイルの構成

ライティングスタイルは以下の項目で構成されています。

  1. 考え方(必須)
  2. 説明(必須)
  3. 議事録
  4. 出典

考え方(必須)

見出しのみでも内容が把握できる最低限の情報量で、言葉をデザインする際の姿勢を一文で表現します。

説明(必須)

考え方に対して、詳細に言語化します。必要に応じて、例を用いることもあります。

議事録

Slackのスレッドや議事録などがある場合には、記載します。

出典

リファレンスとして使用したものがある場合には、記載します。