LIVESENSE ENGINEER BLOG

リブセンスエンジニアの活動や注目していることを発信しています

プログラマーに贈る、わかりやすい文章を書くための技法

これは Livesense Advent Calendar 2022 DAY 8 の記事です。

転職ドラフトでエンジニアをしている verdy_266 です。

僕の2022年を振り返ると、採用広報チームでの活動を無視することはできません。転職ドラフトの開発を行う傍ら、昨年末に採用広報チームにジョインし、記事の執筆や校正に多くの時間を割いてきました。
今まで記事を投稿したことがなかったこちらのブログにも共作含め5記事を投稿し、11月には Software Design への寄稿の機会をいただくこともできました。文章を書くことが思った以上に好きなんだなと発見があった年でもありました。

made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp made.livesense.co.jp

弊社のルールとして、このブログに記事を掲載する際には、一度採用広報チームのレビューを受けることになっています。今年はすでに 31 記事が投稿されていますが、その(全てとは言わずとも)ほとんどを校正してきました。
今回は、記事の執筆・校正作業を繰り返す中で、わかりやすい文章を書くためにできることについていくつかの気づきを得たのでシェアしようと思います。
残念ながら文章を書くことから逃げられないのがプログラマーの仕事です。人工言語だけでなく自然言語にも強くなりましょう。

ちなみに、今回の記事は、記事全体の構成というよりは1文ごとの文法構造に焦点を当てています。記事全体の構成については、11月に執筆された以下の記事をご覧ください。

made.livesense.co.jp

英語を勉強しよう

いきなり突拍子もないことを言っているように聞こえるかもしれないですね。

「わかりやすい文章を書く」ということをとりあえず忘れたならば、プログラマーが英語を勉強すべきだということに対してはそれほど異論は出てこないような気がします。公式ドキュメントを筆頭に英語で書かれた情報はかなり多く、英語がゆっくりでも読めることはプログラマーとして大事なスキルです。
ただ、ここではもう一歩踏み込んで、英語を勉強することで、日本語の能力にもいい影響を及ぼすことができるのではないかという話をします。それは、我々が外国語として英語を読む際には、主語と述語がどれであるかを意識せざるを得ないからです。

さて、英語を読んでいくと、そのうち英語のリズムがわかるようになります。長い文章でも主語がどこまでなのかつかめるようになったり、主語と述語だけ抜き出して要するにこの文章は何を言っているのかを把握することができるようになったりします。

すると、日本語の文章を書くときも、主語と述語を気にすることができるようになってきます。

例えば、次の文章を読んでみてください。ある記事で、実際に遭遇した文章です。

スクラムを導入するメリットとして、スクラムイベントで必要なコミュニケーションを行うことで、メンバー間の認識齟齬の解消や問題の早期発見と共有がしやすくなると考えています。

主語と述語だけを(無理やり)抜き出すと、「スクラムを導入するメリットとして、〜〜がしやすくなると考えています。」となります。
この文章の最初に出てくる名詞は「スクラムを導入するメリット」なので、これが主語だと考えたいのですが、そうすると「考えています。」に合わないですね。「考えてい」るのは「私(筆者)」でしょう。
では、「スクラムを導入するメリット」に対応する動詞はどれでしょうか。「しやすくなる」が対応するのは「スクラムを導入するメリット」ではなく、「メンバー間の認識齟齬の解消や問題の早期発見と共有が」でしょう。
そうです、この文章は主語と述語が対応していないのです。

これを次のように変えてみましょう。

スクラムを導入するメリットとして、スクラムイベントで必要なコミュニケーションを行うことで、メンバー間の認識齟齬の解消や問題の早期発見と共有がしやすくなることが挙げられます

「スクラムを導入するメリットとして〜〜が挙げられる」という構造になりました。

あるいは、次のように変えてもいいかもしれません。

スクラムを導入するメリットとして、スクラムイベントで必要なコミュニケーションを行うことで、メンバー間の認識齟齬の解消や問題の早期発見と共有がしやすくなることだと考えています。

「スクラムを導入するメリットは、〜〜がしやすくなることだ」という文章を、「(私は)〜〜と考えている」が挟んだ形です。 I think that ~~ という形の文章は英語でよく出てきますよね。

そもそも、主語と述語が離れていることがわかりにくい文章の原因だとする考え方もあると思います。次のようにしてみましょう。

スクラムを導入するメリットとして挙げられるのは、スクラムイベントで必要なコミュニケーションを行うことで、メンバー間の認識齟齬の解消や問題の早期発見と共有がしやすくなることです

こちらの方がより英語に近い語順になりましたね。

助詞に敏感になろう

主語と述語がわかるようになったら、次は助詞に気をつけて自分の文章を見返してみましょう。日本語は助詞(いわゆる「てにをは」)が重要な言語ですから、日本語を扱う以上は助詞から離れることはできません。

例えば、次の文章をみてみましょう。これもとある記事の校正で出会った文章です。

多くの環境ではproductionのRDSスナップショットの開発アカウントへの共有は行うと思うので、

「多くの環境で(は)」は「行う」にかかり、主語にも述語にもならない副詞ですね。なので一旦脇に置いておきます。
「と思うので、」も「私(筆者)は」が省略された述語だと考えると、とりあえず脇に置いておいて良いでしょう。
すると残りは「productionのRDSスナップショットの開発アカウントへの共有を行う」となります。

これを見ると、「の」が連続していて読みにくいですね。「の」を様々な助詞に置き換えることで、それぞれの名詞がどういう役割を担うかはっきりさせてあげましょう。

例えば、次のようになります。

多くの環境ではproductionのRDSスナップショット開発アカウント共有する(処理は必須だ)と思うので、

「〜〜を〜〜に共有する」という構造ができたので、それぞれの名詞の役割をはっきりさせることができました。

誤字脱字はプログラムにお任せしよう

文章を書いていて、残念ながら避けられないのが誤字脱字です。誤字脱字は読者から見ても明らかにそれとわかるものであり、誤字脱字が多いと文章の信憑性自体を疑われかねません。
ただ、人間の力では誤字脱字をゼロにすることは難しいかもしれません。長い文章になればなるほど、目でチェックするのには無理があります。

せっかく我々はプログラミングという武器を持っているので、それを有効に使いましょう。

ここで詳しく説明はしませんが、 textlint という文章校正のためのツールがあります。VSCode の拡張機能で textlint を使ったものもあるようですね。

marketplace.visualstudio.com

ツールを便利に使って、時にはカスタマイズしながら、誤字脱字を予防しましょう。
この記事も、textlint を使った社内ツールのお世話になっています。

最後に

英語を勉強しろとか、助詞に敏感になれとか、一朝一夕ではどうにもならないことをたくさんお伝えしてしまいました。

しかし、これらの観点を頭の片隅に入れた上で、チャットでもドキュメントでもブログ記事でも、自分の書いた文章を公開前にもう一度見返してみることが大事なのかなと思います。

特に今月はアドベントカレンダーでブログ記事を書く方が多いかと思います。この記事で読みやすい文章が少しでも増やせたら幸いです。