エンジニアの文章作成術

この記事は ジーズアカデミー Advent Calendar 2019 の6日目の記事です。

はじめに

私は現在とあるSIerに在籍しています。SIという仕事柄、設計書や提案書などの文章を書く場面が多くあります。これらの文章は、文学的なものではなく技術文書における文章であり、それは自分が伝えようとした内容と読み手が解釈した内容との差異を極限まで小さくしなければなりません。

文章が産む悲劇

エンジニアの皆さんは、残念な設計書（またはコード）とご対面して失望感に襲われた経験はないでしょうか。間違っている部分や抜けている部分を正す必要があったり、実装されているコードを読み解く旅に出る必要があったり。
設計書もコードもその場限りの消え物であれば、どんな内容でも目的が果たせればよいのかもしれませんが、仕事で設計書やコードを書くと言った場合、そうはいきません。必ずあとに続くひとに迷惑を掛けてしまいます。往々にしてそのひとが未来の自分ということもありますよね。
なので、少なくとも自分が書いた設計書でそのような悲劇を産まないようにしたいものです。
本稿、えらく仰々しいタイトルを付けてしまいましたが、私が日頃エンジニアとして文章を作成する際の注意点を整理してみました。

一文一内容

まずいちばんに気をつけているのは、1つの文に2つ以上の内容を含めないことです。これは大学の日本語表現技法という講義で口酸っぱく聞かされた言葉であり、いまでも印象に残っています。何も考えずに書いていると、2つ以上の内容が含まれた文を作ってしまうことは結構多くあります。大体の犯人は「が」です。気を抜くといつもこいつにやられています。このnoteの文章中にも探せばやられている場所はあるかもしれません。逆接だけではなく、文の単純な接続に使えるので、無意識のうちに文を繋いでしまうのです。そしてよくわからない文章になって死にます。もしかすると頭で考えているときは口語っぽい思考回路になっているからかもしれません。口語だと、あまり気にならないですからね。
ちなみに、「が」についていい記事があったので参考として引用させていただきました。

「が」は逆接でだけ使いなさい―便利に見えて難しい接続助詞「が」の用法

見出しをつける

一文一文がいい感じに出来たら、今度はそれをグループ化して段落を形成します。このとき、段落を作ったときにその見出しをきちんと考えることが重要です。小学生並みの感想ですが、これはとてもむずかしいさぎょうです。なぜなら、見出しをつけるということは、その段落を抽象化していることにほかならないと考えているからです。名は体を表すというように、見出しで何を伝えたい段落何かがわかると読み手の理解を助けることに繋がります。また、見出しがあることによって含まれている一文一文の内容が適切がどうかも判断できます。もしかしたら別の段落に書いてあげたほうが、スッキリすることもありますよね。文章全体の整理整頓をしているイメージです。（プログラミングも一緒かも。）

見出しの解像度を上げる

見出しはその段落中に書かれている文の内容から外れてはいけないですし、構成している文たちも見出しの内容から外れてはいけません。一度見出しが付けられたからと言って、できた気にならないことも大事です。『考える技術・書く技術』では次のように述べられています。

“グループ化した考えを批判的な目で眺めてみるというのは考えるプロセスの最重要部分といえる”
『考える技術・書く技術』バーバラ・ミント[著]

抽象化（見出しをつけること）と具体化（文を精査すること）を繰り返して、見出しの解像度を上げていきます。これがきちんとできていると、文章全体も整ってくるように思います。
私自身、このあたりの抽象化思考はこれから先ずっと修行しなければならないなと思っています。じゃあどうやって修行するの？というと、ひたすら文章を書いてそれを抽象化するのを繰り返すしかないですよね。この辺りは「コードは量」というジーズでうん百回と聞いた言葉を思い出します。

思いやりを大切に

当たり前だろと思う方も多いとは思いますが、その文章の先にひとがいることを忘れている方が多くいる様に感じます。場当たり的に作業感覚でこなしているような文章を読むと、なにが楽しくて仕事しているんだろうと常々思います。私達がなにかものを書くといったとき、それは誰かに対してコミュニケーションを取ろうとしているのです。つまるところ文章を書く上でいちばん重要なのは相手に対する思いやりではないでしょうか。思いやりがたくさん詰まった文章を書くことで、他のプロジェクトメンバーだったり、未来の自分だったりを幸せにできるかもしれないと思うのです。

おわりに

文章の作成術と書いておきながら、ツッコミどころを残した文章であることには自分も気がついておりますので、生暖かい目で見ていただければと思います！
ご意見・ご感想あればよろしくお願いします。