その他ノウハウ

SEが読みやすい文章を書くためのたった2つのチェックポイント

この記事に書いてあること

我々SEは仕事で大量の文章を書きます。その中で、特にメールや手順書などでお客さんとかに向けた文章を書くときに読みづらいとか意味が分かりづらいとかの指摘を受けることはないでしょうか。
私は以前そのような指摘を多く受けていました。

改善するために色々な文書作成の本とかで勉強してみたのですが、どれもイマイチ効果がありませんんでした。
というのも、設計書、報告書、仕様書、マニュアル、手順書、顧客へのメールと色々な種類の文書を書くのですが、それぞれ書き方があって、例えば「設計書 書き方」「マニュアル 書き方」とかでググればある程度は出るのですが、そもそもの「なんか読みづらい」、「意味が分かりづらい」みたいな指摘はイマイチ減ってきませんでした。

これは表面的なスキルだけを調べているのであって、根底にある「文章を書く」ということを学んでいないために起こっていました。
しかし、根底にあるスキルを学ぶのは大変なこと・・・

そこで、文書の書き方ではなく文章の書き方についていくつか分析した結果見えた、とても簡単な小手先での改善点を書きます。

たった2つです。これを意識するだけであらゆる文章がグッと読みやすくなり、指摘がとても減りました。具体的には7割ぐらい減って、設計ミスや手順漏れなど仕様に関する指摘だけになり、レビューの効果が大きく上がったのを覚えています。

大事なのは、ここで取り扱うのうは「文書を書く」ではなく「文章を書く」と言う点にフォーカスしているということです。

「文書」と「文章」の違い

ここで取り扱うのは文章の書き方です。ここで言う両者の違いは何かを定義しておきます。

  • 文書
    設計書やマニュアル、メールなど「特定の書式や目的」を持った文章や図の集まり。
  • 文章
    文書を構成する要素の1つ。文字によって表現するもの。

というところでしょうか。

注意すべきたった2つのポイント

SEが書くあらゆる文書において読みやすさを向上するためのポイントは以下の2つがとても重要であると思うようになりました。

  • 謙譲語や尊敬語を使わず、丁寧語オンリーで書く。
    ※「貴社」や「お電話」の「おをつける」くらいは使いますが・・・
    ※メールとかを無駄に丁寧に書く人ほど仕事遅いよな〜と思っていたら、こちらで理由が書いてありました。なるほど。
  • 削除しても同じ意味で伝わる単語は全て削除する。

です。

もちろん、これが全てだとは思っていないのですが、「手っ取り早く」「どの文書でも使える」「読みやすくなる」と言う点では効果的だと思います。

謙譲語や尊敬語を使わず、丁寧語オンリーで書く。

謙譲語や尊敬語はとても難しいと感じています。
謙譲語は自分を下げ、尊敬語は相手を上げるということになりますから、入り混じってしまうと途端に分かりづらい文章になってしまいます。
一番問題だと思うのは、中途半端な知識で敬語を扱うと

  • 記述にかかる時間が長くなる
  • 相手に伝わりづらくなる
  • 言葉を間違っている

なんてことになり誰も幸せになれません。
※敬語をマスターすればいいだけの話なのですが、現実問題としてそこに時間を割く余裕はなく・・・・


バリエーションが多いですし、文章をガーーーっと書いているとどれがどっちなんてことを考えている暇はありません。
なんとなく普段使っている言葉や知っている言葉を使って書くことが多くなりますが、正しいかどうかは正直確証はありません。

以下の文章を読んでどう思いますか?

お客様が作られたお菓子をいただいた。(食べたという意味で)

これは正いと思いますか?間違っていると思いますか??
ポイントは以下です。

  • 「作られた」は尊敬語
  • 「いただいた」は謙譲語

2つが混じっているということになります。

これは正しいです。
日本語の文章において重文や複文というのがあり、先の例は以下の意味であると考えられます。

重文:お客様が(私に)作られたお菓子を、(私は)いただいた。
複文:お客様が作られ、(私が)いただいた。

文の構造

このように考えると、

  • 作ったのはお客様なので尊敬語を使うのは正しい
  • 食べるのは自分なので謙譲語を使うのは正しい

次の例はどうでしょうか。

娘夫婦が作られた料理をいただいた。

これは正しくないです。一般的に娘は目上の対象ではないので尊敬語は不要ですし、同様の理由で謙譲語も不要です。
で、経験上、

こういうことを考えて書いていたら、もっと重要なシステムの設計とか手順の記述といったところが疎かになりました!
しかも、敬語マスターではないのでおかしな文章になっていることも多々ありました。

ということです。レビュー会でもこういう表面的な日本語の誤りばかりに注目がいくようになってしまい、後になってから仕様の誤りなどが噴出するケースが非常に多かったです。

設計書とかのドキュメントなら、丁寧語すら使わなくてもいい場合が多いと思います。

1)ユーザーは画面にパスワードを入力する
2)入力したパスワードをバリデーションする

みたいな書き方でも問題ないと思いますが、メールや手順書、報告書ではそうは行きません。

ということで、全ての文書で丁寧語使っておけば間違い無いでしょという結論にいたりました。

尊敬語や謙譲語を使って書かれたメールを丁寧語オンリーに書き換えてみましょう。よくある敬語の間違いが含まれた、送りがちな文章をを例としました。メールが例ですが、設計書や手順書なども同様のことが言えます。

先日のお電話でお話しさせていただいた件でご連絡させていただきました。
あの後、送っていただいた資料を拝見し社内でも検討を行いました。
以下のようにすることで対応可能なのではないかと考えました。
1) xxxxxxxx
2) xxxxxxx

また、XXXは次週からの実施でよろしかったでしょうか?
合わせてご確認をよろしくお願いします。

以下のようにしても大抵の場合問題ないと思います。

先日のお電話の件でご連絡しました。
あの後、送られた資料を確認し社内でも検討しました。
以下で対応可能と考えました。
1) xxxxxxxx
2) xxxxxxx

また、XXXは次週からの実施で良いでしょうか?
ご確認よろしくお願いします。

短い例文ですけど、スッキリしましたよね。
受け取った方もこの程度であれば失礼だなんて思わないはずです。いちいち尊敬語とか謙譲語を意識して読む人なんていないですから。

大事なのは中身を明確に伝えることですからね。

【※ただし、謝罪などの場面ではとことん謙りましょう。】

削除しても同じ意味で伝わる単語は全て削除する。

文章においては、一文を少ない単語数で記述するほど読みやすく、理解しやすくなります。

で、多義文とか句読点がとか色々言われますが、まずは一旦それらの難しいことは無視して、一文を短く・少ない単語数で書くようにしてみてください。

これだけで大分文章はスッキリしてきます。

まずはメール。以下は実際に後輩がやりとりしたメールを特定できないようにボカしたものです。2点あります。

顧客向けの問い合わせメールのダメな例

いただいた設計書の記載について確認させて頂きたいと思いご連絡いたしました。
3章に記載されているインタフェースにある「ユーザーID」という項目が必須になっているようなのですが、前回実施したレビュー会の結果では非必須になったという様に認識しております。

もし必須である場合は外部連携システムの開発チームにインタフェースの変更を連絡する必要がありますので、再度ご確認をお願いいたします。

社内の総務向けの問い合わせ向けメールのダメな例

稟議の種類についてお伺いしたいことがありご連絡しました。
現在、顧客向け案件のテストにおいて環境構築のためにAzureとクラウドサービスのアカウントの購入を検討しております。

Azureとクラウドサービスの稟議書は、一般稟議の扱いになりますでしょうか。
それとも特別稟議の扱いになりますでしょうか。

お忙しいところ恐縮ですが、ご回答いただけますと幸いです。

謙譲語とか色々入っているのですが、修正していきます。

  • 丁寧語オンリーで行く
  • 意味の変わらない語は削除する

顧客向けの問い合わせメールの修正例

設計書の記載を確認したくご連絡しました。
3章に記載のインタフェースにある項目「ユーザーID」が必須になっていますが、前回実施したレビュー会の結果では非必須になったと認識しています。

もし必須である場合は外部連携システムの開発チームにインタフェースの変更を連絡するので、確認をお願いします。

  • 「について」とかは大抵いらない
  • 「いたしました」は「しました」でいい
  • 「という」も大抵いらない
  • 自分で確認したんだから「様なのですが」という予防線は張らない
  • 「様に」も大抵いらない
  • 「する必要があるので」という言い回しは「するので」で大抵通じる

社内の総務向けの問い合わせ向けメールの修正例

稟議の種類を聞きたくご連絡しました。

Azureとクラウドサービスの稟議書は、一般稟議と特別稟議のどちらしょうか。

ご確認お願いします。

  • 「お伺いしたいことがあり」はいらない
  • 「現在、顧客向け案件のテストにおいて環境構築のためにAzureとクラウドサービスのアカウントの購入を検討しております。」細かい背景は要らない。稟議の種類を聞くという場面においては、この背景は不要。相手にとって意味のない文章は消す。
  • 「なりますでしょうか」はバイト敬語みたいなもん
  • 「お忙しいところ恐縮ですが、ご回答いただけますと幸いです。」は硬すぎるのでもっとシンプルに言えばいい

まとめ

設計書や仕様書ではあまり出てきませんが、メールとか手順書ではこのように謙譲語や尊敬語を使う場面が少なからずあります。
しかし、敬語とか尊敬語を勉強するのはとても重要なのですが、日本語は奥が深いと言いますか・・・・習得にはかなりの時間を要するので、一旦はこれらの小手先スキルを使って腕を磨くというのもどうでしょうか。

書いていてメールや手順書に出てくる文章ばかりになってしまったので、最後に設計書でよく見る書き方を修正します。
まぁやることはほとんど同じです。

設計書のダメな例

1)はじめに
 本書では◯◯機能における◯◯画面のレイアウト設計について記載します。
 〇〇機能全体の設計については、「設計書〇〇」を参照してください。
 また、本書では〇〇画面のインタフェース設計についての記述は行いません。インタフェース設計については「設計書〇〇」を参照してください。

改善ポイントは以下でしょうか。

  • 「画面のレイアウト設計」は「画面レイアウト設計」と言っても同じ
  • 「おける」とか「ついては」はなくても通じる
  • 主語が明らかな場合は別に繰り返さなくてもいい。

設計書の修正例

1)はじめに
 本書では◯◯機能の◯◯画面レイアウト設計を記載します。
 〇〇機能全体の設計は、「設計書〇〇」を参照してください。
 また、本書では〇〇画面のインタフェース設計の記述は行いません。「設計書〇〇」を参照してください。

だいぶスッキリしました。設計書も同じように、無駄をとことん省くことで意味が直接伝わる様にできそうですね。

###############お知らせ################
ブログランキングのITカテゴリに参加してみました。
この記事が役に立ったなどお力になれたら、 このバナーを押していただけると嬉しいです。

#####################################

-その他ノウハウ