ソフトウェアエンジニアのための文章技術 原稿をより良くするための表現法編

こんにちは。りまりま団のもふもふです。

技術書典6、もうすぐサークル申し込みの締め切り日です。迷っている人はおはやめに手続きしてしまいましょう。

このエントリでは下記3つのエントリを受けて、自分の書いた文章をより伝わりやすく改善するためのヒントをお伝えします。

まだ本文も書けてない?それならこのエントリを読んで本文を書きましょう。これから話すことは本文が書けてから実施するべき事項です。詳しい理由はエントリを参照して欲しいのですが、あれこれ考えて手が止まってしまうのが1番良くないことです。

原稿の推敲はなぜ大切なのか?

推敲という言葉があります。 商業誌では、編集者があなたの代わりに推敲を行います。1 あなたは提案された案を受け入れるか決め、原稿を修正するだけです。

しかし、同人誌には編集者が付いていません。自分で行う必要があるのです。2

原稿を書き上げたあなたはこう言うでしょう、「頑張って本文も書けた。もう疲れたし遊びたいし他のことしたいから入稿しちゃえ!」と。

ちょっと待ってください。推敲は絶対にやるべきです。わかりやすい文章であればあるほど、あなたが広めたい技術を他人に伝えることができるからです。

大して変わらないから大丈夫?では、この文章を見てください。

  • データの内訳に応じて円が分かれていきます。 円を分ける条件を指定しないとデータの総件数が表示されるだけなので、パイを分割する設定を一緒に入れましょう。3
  • 円グラフを作成するための機能です。データの内訳を分析する用途で利用します。設定を変更すれば、円の中央が空いている”ドーナツ型”のグラフを作成することも可能です。4

実はこれ、どちらもKibanaというプロダクトのPie Chartという機能を説明したものです。画像の右上にドーナツ型の円がありますね。それがPie Chartのグラフです。

f:id:MofuMofu:20190126183007j:plain

Kibanaの画面例
www.elastic.co

この機能の詳細は、本題ではないため割愛します。言葉の使い方・文章の並べ方・句読点の違いで全然印象が違うのがわかりますか?

はじめの文章は「???」と思う点がたくさんあるように感じたのではないでしょうか。「データの内訳に応じて円が別れていきます」と言われて「Pie Chartを使うと円グラフが描ける」とすぐ解釈できる人は少ないと思います。 この「???」という感情が蓄積されると、本に対する印象は「読みにくい本」へ変化します。こうなってしまうと、あなたの伝えたいことは3割程度しか伝わりません。あなたの努力は水の泡、です。

読者の読解力の問題だ!と思われる方もいるでしょう。ここで『20歳の自分に受けさせたい文章講義 (星海社新書)』から、私が1番好きな文を引用したいと思います。5

www.seikaisha.co.jp

専門書やマニア向けの雑誌などが(一般読者にとって)読みづらいのは、このためだ。出てくる言葉が難しいのではない。読者に甘え、本来やるべき説明を怠っているから、読みづらいのである。

私も同感です。「伝わらない」のは読者のせいではありません。本を書いた人の責任です。古賀さんは「専門性に逃げるのは、書き手の怠慢であり、甘えにすぎないのだ」と表現しています。

専門書の位置づけで技術同人誌を書くのであればまだしも、タイトルやキャッチコピーに「わかりやすい」「初心者の/はじめての」といれるのであれば、絶対に専門用語でのゴリ押しは避けるべきです。

あなたが思っている以上にタイトル詐欺の本は多いです。例えば、特定の技術のAPIに関する解説だけしか書かれていない本を初心者が読み、「わからない」と言われたときですら、本を作った人に落ち度があるのです。対象読者をきちんと定め、誰が見てもわかるように明記する(誤解ないように宣伝する)のは本を作る人がやるべきことです

読者というものは勝手なように見えるかもしれません。理不尽なのはわかります。しかし、読者はあなたの書いた本からしか情報を取得できません。わからないことは調べて読んでほしい?行間を読んでほしい?技術書に対するAmazonのレビューをみれば、そんなものは幻想だとわかります。

読者のためにも、あなたのためにも推敲はやりましょう。

推敲する観点

普段の生活で推敲をすることはどのくらいありますか?メール文化の中にいれば、そこそこあるかもしれません。チャットだと少ないのではと思います。

推敲できるか不安なあなたへ、もふもふちゃん調べの推敲観点ランキングを発表します。

  1. 語調・記法は統一されているか
  2. 接続詞の用法は正しいか
  3. 句読点の量と位置
  4. 一文の長さは40文字以内か
  5. 初見の単語には意味の解説があるか
  6. 助詞の使い方は正しいか

4位までの観点は絶対にやっておきましょう

原稿を作成している環境によって、使えるやり方が変わってきますが、いくつかおすすめのやり方を挙げておきます。

紙出しする

ベタですが、一度紙に印刷する方法です。紙出しの利点は、原稿の仕上がりサイズを直接確認できる点です。

字や段落が詰まって読みにくいという点をにチェックするためには、一度紙出しするのが確実です。

インク代や紙代がかかるので、ほぼ完成となったところで紙出しすると良いでしょう。とはいえ技術同人誌を作るのが初めての場合、紙面で仕上がりを確認する工程はサボらない方が良いです。

タブレットを使う

私はPDFをiPadに送信し、Apple pencil(初代の😡)で赤入れすることが多いです。

紙出しの手間を省きつつ、作業環境と別のディスプレイで確認することで、見落としを防ぐようにしています。

タブレットを持っていない場合、初期購入費用がかかるのが難点です。

lintツールを使う

lintツールを使いたい!そんな人もいるでしょう。技術同人誌界隈で利用が観測されたツールを紹介します。

github.com

github.com

redpen.cc

注意点として、

  • テキスト形式の原稿にしか使えない
  • 論理構成や話の流れなどはチェックできない

ことがあります。最後は自分で確認することには変わりません。

ただ、助詞の使い方・句読点の量・一文の長さはlintツールが自動で教えてくれます。とにかく文章を書くのに自信がない場合、lintツールに助けてもらうのも良いでしょう。

まとめ

  • 推敲は大事だよ
  • 伝わらないと負けだよ

推敲に時間をかけるためにも、本文は早いとこ完成させましょうね!


  1. Twitterを見ていると、ひどい編集者の話もあったりします。また、編集者の方から技術的な観点での推敲は受けにくいと言われています(外部レビューを頼むことが多いです)。ですが、ここでは考慮しません。

  2. 合同誌に寄稿する場合は除きます。

  3. これは技術書典2のときに書いた「ログと情報をレッツ・ラ・まぜまぜ!~ELK Stack で作るBI環境~」という本の初稿です。

  4. この文章は、このブログを書くときに書きました。初稿を書いたときから2年弱経っています。続ければそれなりにうまくなるものですね。

  5. 新書なので電子版は存在しません。しかし、内容は一読する価値があります。本の感想や紹介はAmazonのカスタマーレビューに譲りますが、私は大学生のときにこの本に出会えて本当に良かった、と思っています。