得意な言語は何ですか？ ─母語を極めろ……！─
突然ですが質問です。
あなたは何人かのメンバーとともに、ユーザガイドの改訂を行っています。
コミットメッセージに次の一文が記されていました。
メニューバーの写り込みに伴うスクショの差し替えをしています。
この一文、斜め読みをしてパッと瞬時に理解できましたか？
こんにちは、当記事は PHONE APPLI Advent Calendar 2023 (Qiita) の12月5日担当として書いています。
プログラミング“言語”ではなくて、日常生活で使っている“言語”にまつわるお話なので、Qiitaではなく、はてブで更新しております。
さて、冒頭の質問に戻りましょう。
メニューバーの写り込みに伴うスクショの差し替えをしています。
このメッセージ、分かりにくくありませんか？
この一文だけ読んでとくに何も感じない人であっても、別の文章と比較することで「分かりにくいな」と感じるのではないでしょうか。
X: メニューバーの写り込みに伴うスクショの差し替えをしています。
Y: メニューバーが写り込んでいたので、スクショを差し替えました。
Xが分かりにくい文章、Yが分かりやすい文章、です。
もしXでもYでも違いを感じないのであれば……すまないが……君は文章表現能力が低いと言わざるを得ない……。本当にすまない……。この記事を読んで少しでも君の文章表現能力が向上することを願うばかりだ……。
では、XとYにどういった共通点・相違点があるのでしょうか？
私は、次のように考えました。
- 2つの文章の共通点
- このコミットでどんな変更が加えられたのか理解できる。
- 2つの文章の相違点
- 変更した理由が不明瞭か、明瞭か。
- 変更作業はまだ進行しているのか、完了しているのか。
順に見ていきましょう。
共通点: このコミットでどんな変更が加えられたのか理解できる
これは、コミットメッセージを書く上で大切な要素の1つですね。
XもYも、「スクショを差し替えた」ことが明らかです。
恐らくコミットメッセージを書いた人は、コミットの変更対象を正確に記そうという気を配る余裕はあったのでしょう。
あるいは、コミットメッセージを書く時のチームのルールで、変更対象を明らかにすべし、と決められていたのかもしれません。
相違点: 変更した理由が不明瞭か、明瞭か
XもYも「メニューバーが写り込んでいたため」という理由に変わりはありません。
ではなぜ、Xは不明瞭で、Yは明瞭に感じるのでしょうか。
──Xは冗長で、Yは簡潔だからです……！
もしXでもYでも違いを感じない方は、“そういうもの”だと思ってください……。
文章表現の話で頻繁に出てくる考え方として、「一文一義」「ワンセンテンス・ワンメッセージ」というものがあります。
雑に言い換えると「何でもかんでも一文におさめようとするな」ということです。
Xの場合「伴う」という言葉が曲者です。
日本語としては誤っていませんし、たとえば、知人に手紙を書いたりスピーチの原稿を書いたりする時には効果的な言葉といえるでしょう。
ですがコミットメッセージのように状況を正確に伝える必要のある文章の場合は、文章の見栄えや耳馴染みのよい言葉ではなく、あくまでも「一文一義」「ワンセンテンス・ワンメッセージ」のルールを守ることで、役割（状況を正確に伝える）を果たすことを優先したいところです。
手紙や原稿のような、日常で用いる言葉遣いとは異なるポイントに気をつけなくてはなりません。
相違点: 変更作業はまだ進行しているのか、完了しているのか
これは、コミットメッセージを読むタイミングがいつであるかを意識すると分かりやすいかと思います。
恐らくコミットメッセージを書いた人は、「コミットして、PRでapproveになればこのタスクは完了」という意識で書いているのではないでしょうか。
コミットメッセージには、そのコミットがどういった状態であるかを書くべきですので、コミットする内容が一区切りついているのであれば、過去形「差し替えました」と書く方が分かりやすいといえます。
自分がいま着手している作業の一連の流れがどうであるかではなく、後からコミットメッセージを見た人がそのコミットがどういった状態になっているのかという視点を意識できるとよいですね。
さて、色々と見てきたのですが、最後にもう1つ分かりにくさを助長している言葉があります。
「差し替える」という動詞を「差し替え」という名詞扱いしている箇所です。
文章を短く書こうとするあまり、体言止めを多用するケースを時折見かけますが、体言止めの書き方に慣れている人が丁寧な文章を書こうとした時に「動詞の名詞系 ＋ する」といった書き方になることが多い……のかもしれません。知らんけど。
つらつらと見てきましたが、XもYも、実はどちらも私がコミットする時に書こうとしたメッセージです。
とくに何も考えずXを書き、それを推敲してYに書き直しました。
最初から綺麗な文章を書けるに越したことはないでしょうが、それよりも、推敲をして他の人や未来の自分がどう感じるかまで気を配ってメッセージを書くことこそが、手っ取り早く分かりやすい文章を書くコツなのではないかなと考えています。
あとは……そうですね……一文は50〜60文字程度におさめるのがセオリーだとか、漢字3割・ひらがな7割だと読みやすいだとか、巷に溢れるテクニックはあれこれあるのですが……テクニックを使いこなすためにこれだけは覚えておきましょう。
母語だからと思いつくままに書いて書きっぱなしにするのではなく、そこからもう一捻りすることが大切！
一文がよりシンプルになるように、Simple is Best、Less is More、要するにごちゃごちゃした文章を書くのはやめようね、ということです。
ブログの文章も、もっとシンプルに書けたらいいのになぁ。
