技術記事を書くときに意識するとちょっと得すること

この記事は　ベリサーブ Advent Calendar 2020　の20日目の記事として作成しました。（はじめてのnoteです。どきどき。。）

この記事を書いている人

株式会社ベリサーブというソフトウェアテストの会社で広報をしています。過去、結構長い期間に渡ってSI系の仕事で小規模火災を消化する仕事をやっていたので、ソフトウェア開発のことは少し位は知っているつもりです。

現在のお仕事の一つに、社内用、社外用の広報誌の編集があります。取り扱う内容の中心はソフトウェアの開発・テストに関わるような技術情報です。多くの方に技術記事を書いて頂き、それらをA4冊子に換算して５~６ページの内容にまとめていくというお仕事をやっています。

この記事でお伝えしたいこと

社内外を含めた多くの方の文章に目を通すと、「わかりやすい！」と感じる文章や、「読みづらい！」と感じる文章があります。編集については素人同然なので「わかりやすい！」文章が書けるようになる即効性のある方法などを出せるわけではありませんが、「読みづらい！」と思う文章にはある種共通することがあり、逆にそれらを気を付けるようにすれば「わかりやすい！」文章に一つ近づくのではないかと思っています。

この記事では文章のチェックの際に行っていることを何点かご紹介したいと思います。せっかく良い内容を発信しても、表現の仕方が残念で伝わらない、というのではもったいない！技術文章を書いている、書いてみたい方の参考になることがあれば嬉しいです。

１．幅広い方に読んでいただく文章を作るときの前提

以前、上司から幅広い読者を対象とした文章を作成する際の前提として「記事を読むために必要な情報は文章内に書かれている」ことが重要と言われたことがあります。確かに、専門分野に特化した技術者の方が書いた文章は、テーマについての最低限の情報のみで書かれていることが多く、文章を読むためにインターネットや、専門書籍で調べる必要があるため非常に読みづらく感じることがあります。このような時、説明の文章を追記していただいたり、注釈などを足したりしています。

２．用語を気にしてみる

技術文章を読むときの挫折の第一歩は「用語」がわからないときです。特に、英字の略語などがいきなり登場し、読み進めていくとようやく用語の説明にたどり着くという文章にはよく出くわします。文章の順序を入れ替えるとか、かっこ（）を使って補足するなどの工夫でぐっと読みやすくなる気がします。

例）CNT（千葉ニュータウン）、CNT（カーボンナノチューブ）
…例にはあまり深い意味はないです。。

また、用語の表記が揺れているとそれだけでストレスを感じます。同じ意味で使う用語は統一されているかは確認したほうが良いと思います。ちなみに、大衆週刊誌で編集をしている友人は、読者を飽きさせないように、わざと言葉を言い換えて使っているらしいです。。。

３．文章はつながっている？

読みづらいと感じる文章を編集する際、ロジック・ブランチという原因と結果の関係に着目して分析する思考ツールを使って文章を分解してつながりを確かめることがあります。具体的には、できるだけ文章中の言葉をそのまま使い、文章の小見出しレベルのトピックを付箋などに書き出して、原因と結果の関係にあるものは矢印でつなぐという作業を行います。

読みづらい文章は構成などが十分に練られておらず、ただトピックを並べていることが多いからです。「読みやすい」と感じる文章で同じ作業をすると、見事に結論に向かって矢印が伸びていく構成となる傾向があります。

結論と他の文章がつながっていない場合、原因が欠けているところには文章の追記をお願いしたり、結論につながらないような話題は思い切って削除したりして構成から練り直す作業を行います。（…本来であれば文章を書き出す前にこの作業を行うのがベストだと思います。）

おわりに

この記事では、文章を確認する際に行っているいくつかのチェックをご紹介させていただきました。文章を編集する作業をしていると、前職で提案書や計画書を書いているときに同じような注意を受けたことがあるなー。。と思い出したりすることがあります。技術文章に限らず、お仕事のドキュメントなどでも同じようなチェックをしてみたら少し良いことがあるかもしれません。

おまけですが、技術文章の執筆や編集に興味のある方、一緒にお仕事してくださる方絶賛募集中です。情報収集や発信が大好きな方、イベント運営や企画に興味のある方、お声かけ頂けたら嬉しいです。