はじめに
ドキュメントやSlackの文章を書くときに、より相手に伝わるように書きたいというモチベーションから、『日本語スタイルガイド』を読みました。基本的な文章作成の指針について、テクニカルコミュニケーター協会が出している本になります。
- 作者:一般財団法人テクニカルコミュニケーター協会
- 発売日: 2016/04/22
- メディア: 単行本(ソフトカバー)
感想や特に印象に残った点についてメモとして残しておきます。
まとめ&感想
「似ている助詞の注意点や語尾の使い分け」といった細かいけど大事な日本語の使い方に始まり、「文章全体をどのように構成していくか」その時の心構えまで説明されています。さらには「文章を校正する際に気をつける点」や「翻訳しやすい文章の書き方」まで書いてあり、広く浅くテクニカルライティングに必要な力をカバーできているのではないかと感じました。
実際に、仕事で文章を書く際に、この本の内容を思い出しながら、文章を書き直しできる機会が増えてきました。
個人的にはもう少し、「ドキュメントをいかにして書くか、どのような構成で書くか」といった点について勉強を深めたいので、『技術者のためのテクニカルライティング入門講座』を読みたいです。
特に印象に残ったところ
読みやすく書くポイント
「ですます調」と「である調」
- 「ですます調」は、優しく柔らかい雰囲気で伝えることができる。また読み手に内容も平易であるかのような印象も与える。なので、読み手が「内容を理解できるかどうか」不安に感じている可能性がある場合は、「ですます調」を用いるのが良い。
- 「である調」は、力強く自身のある雰囲気で伝えることができる。また読み手に内容も正確で厳密であるかのような印象を与えることができる。なので、内容の信頼性が重要な場合は「である調」を使うことがある。
混在させないのが基本だが、例えば操作内容は「である調」だが操作結果は「ですます調」で書くなど使い分けることもある。
能動態と受動態
操作説明を行う文章では、視点を統一するために、利用者を主語にして能動態で書く。それに対して、利用者から見て自動的に行われる操作は受動的に表現する。例えば、利用者が行なった操作の結果は受動態で書く。
時制を統一する
操作を示す文の時制は現在形で統一する。そうすることで、利用者は文章を読み進めながら、機器やソフトウェアをその時点で自らが動かしているような気持ちになる。
1つの文は1つの事柄を書く
文を接続助詞(〜ので、〜が、〜と、など)で繋ぐと、複数の意味を持つ文になりやすいので注意する。
1つの行動を1つの文で書く
1つの行動の説明には1つの文を使う。順番が決まっている場合は、連続した番号をつけると手順の数や順番が明確になる。
「〜します」、「〜してください」、「〜できます」を使い分ける
基本は「〜します」を使う。使用情報では、利用者に実行してほしいことは「〜してください」とし、基本操作を補足するときは「〜できます」と書き分ける。
- 〜します:基本お操作手順。実行するかどうかを利用者の判断に任せる場合も同様。
- 〜してください:操作手順で利用者にお願いする表現。(例:〜を確認してください)
- 〜できます:操作手順で、「〜します」の文を補足するときに使う。
1文は50字以内を推奨する
1分の長さが50字を超える場合は、文を分けられないか検討する。また、名称や説明が複数並んで文が長くなっているときは、箇条書きするなどの工夫も必要になる。
「〜し、」、「〜り、」を使って文を長くしない
前後の関係が分かりにくくなることがあるので、文を分けると読みやすくなる。
また、2つの関係を明確にするためには「〜し、」で繋がずに表現を変える。例えば、「〜しながら」、「〜のまま」、のように。
必要な主語を省略しない
主語が利用者である場合や明確な場合を除いて、必要な主語を省略しないようにする。特に主語が省略された状態で、文の途中で主語を変えると意味が正しく伝わらなかったりする。
主語と述語を近づける
主語と述語の間に長い語句が入ると意味がわかりにくくなるので、主語と述語を近づける。
複数の修飾語・修飾部がある場合は、長い修飾語・修飾部から順に記載する
文字数の多いものから並べると誤解されにくくなる。時を示す修飾語・修飾部は、長さに関係なく前に出す。
読者への配慮を第一に
大事なのは読み手への配慮。相手の視点に立つことがテクニカルライティングにおいて最も重要な要素の一つ。
読み手の知識に配慮する
読み手が知っていることを土台にすることが重要。最初は読み手の知っていることから初めて、段階を追うように説明する。関連知識を持っていないと、全く理解できずに一歩目でつまずいてしまう。
専門用語に関しては、説明してから使う必要がある。もしくは、理解できるように説明しながら使う。本から引用すると、例として以下のような文章がある。
ソフトウェアを自分のコンピューターに組み込む「インストール」という作業が必要でした。
読み手の心情に配慮する
読み手が不安に感じる要素を取り除くことが大切。そのためにも、否定的な表現で無用な不安を与えることは避ける。
- 「〇〇しかできません」→「〇〇できます」
- 「(ポジティブ)ですが(ネガティブです)」→「(ネガティブ)ですが(ポジティブです)」