ソフトウェアエンジニアが文章を良くするために覚えたい３つのこと

近年ではエンジニア向けにテクニカルライティングの技法が流行しています。しかし、テクニカルライティングをやったからといって自分の文章がうまくなっているかどうかよくわかりません。いいねの数も増えないし、なんでや！

結果としてなんだか文体ばかり気にするようになり、しまいには書くことがつらい作業になってしまう人もいるかと思います。

それ、本来文章を書くために必要な行動とはベクトルがちょっと違うことをやってるからそうなってしまうのです。

今日はソフトウェアエンジニアが文章を良くするために覚えたい３つのことを書いていきます。

エンジニアの書く文章でよくみかける根本的な問題

一番でかい問題としてあるのは、何かいい感じの事を書こうと思ってネタ出しをした結果よく知らないことを選んでしまう問題です。

• 書こう、書こうと思っているんだけどスランプに陥ってしまう。こんなはずじゃなかったのに
• あれも書きたい、これも書きたい、結果として文章があらぬ方向に進んでしまう
• 承認欲求を満たすために難しい題材を選んでしまい頓挫する

これらの問題は十分に知っていることを題材とすればだいたい解決します。

テクニカルライティングの技法は極論を言ってしまうと文章スタイル由来から発生する情報伝達の問題を解決することであり、文章を書くうえで肝心な題材の選定や構成に関しては何も教えてくれません。発展的な技法であるためこのようになっています。

ソフトウェアエンジニアがテクニカルライティングの技法を学んだ場合、文体だけはきれいで中身がない文章を作りがちです。これはライターが習得している基礎的な題材と構成についてのアプローチの仕方を知らないまま発展した技法に進んでしまうために発生します。

当然のことではありますが、よく知らないことを書こうとするとよくわからない文章ができあがります。だって書いている本人がよくわかってないんだもの。

1. 十分に知ってる題材を選ぶ！

何も参照しないでソラで説明できることを十分に知っていると言えます。だいたいなにも見なくても言えるけれど、ちょっと参照しないとわからないということでもまぁ知っていると言えるでしょう。

例えばカップそばの作り方なんて説明書きを読まなくても順序だてて説明できますよね？これが十分に知っていることです。文章を書く際は、内容をしっかりと覚えていて再現できる題材を選ぶのが大切です。

十分に知っている題材というのは、熟知しているのであまり考えなくても説明に必要な情報や順序がすぐに思いつけます。間違ったことを書いたら自分で判断できる基準も持っています。それくらい知っている題材を選んでください。

熟知していない題材を選んでしまうと書くのがすごく大変になってしまいます。今の状態でわからないことのほうが多いのですから、書く前に調べて内容を整理しないといけません。書く前の作業のほうが多くなってしまうと大変になってしまいます。適切な難易度を選びましょう。

仕事で調査の時間が与えられているのであればともかく、プライベートはやることがたくさんあります。事前準備が必要なものは難易度が爆上がりしてしまうのです。

十分に知っていることを題材に選んで文章を書く難易度を下げましょう。

2. ひとつの問題解決に厳選する！

次に考えたいことは伝える内容の厳選です。

これから書く文章は相手に何ができるようになってもらう文章にしたいですか？

エンジニアブログなどの記事の基本としてある形式は「問題と解決」です。業務などで遭遇する問題と、その問題を解決するための実際の手順や考え方を書くことで読者に再現できるようになってもらうことを目的としています。読者、というか過去や将来の自分の為でもあるのですが。

文章を読むことで読者のどんな問題が解決できるようになるかを厳選してください。ここで大事なルールを一つ挙げます。問題と解決は必ず一つにしてください。一つの問題に対して一つの解決策を書くことで具体性と明確な方向性が産まれます。

記事としては１つの問題が解決できればそれで十分です。

3. 良し悪し基準は問題解決が再現できるかどうか！

文章の良し悪しを考えはじめると、自分の中に明確な基準がなくてよくわからなくなります。あの記事と比べるとなんとなくよくない気がする・・・そんなことは気にしなくていいです！

「問題と解決」の形式を選ぶ利点は、構成をあまり深く考えなくても書いた文章のとおりに作業をすれば良い感じに解決できる構成になるのが利点です。作成した文章には最低限再現するための手順が説明されているはずなので、そうなるようになっています。

「書いた内容の通りにやれば問題が解決できるか」これを良し悪しの基準としてください。
良い文章は再現手順通りにやれば再現できる。良くない文章は再現手順通りにやっても再現出来ない。このように考えればシンプルな評価基準ができます。

そもそも私達はソフトウェアエンジニアであり、文章を専門とするライターではありません。とりあえず問題が解決できる手順がかければ誰かの役には立ちます。かっこいい文章とか、ぐっとくるエモい文章は文章が得意な人たちに任せれば良いのです。

まとめ

この文章では「ソフトウェアエンジニアが文章を良くするために覚えたいこと」という内容で書いています。この文章において問題解決が再現できるか、というのはどういうことかというと：

• 十分に知っている題材を選ぶ
• １つの問題解決に厳選する
• 読み返して問題解決が再現できるかで良し悪しを判断する

読者がこれらのことを守って書いた結果いい感じの文章が出来上がる。そうであったならこの文章は問題解決が再現できる文章であるということです。今回は作文という抽象的な題材を選んでいるので上手くいくかは半々というところですが。

自分が知ってることは誰かが知らないことでもあります。気にせず公開しましょう。