技術を伝えるときの執筆の方針
この記事でもって、投稿記事が100記事となります。この間に出版された書籍は4冊になりました。ここまで来るのに7年ほどかかりました。
直接お会いした方々はもちろん、名前も顔もわからない方々も含め、大勢の方の暖かいご支援のおかげでここまで来ることができました。心よりお礼申し上げます。
100記事記念ということで、ここでは、当方が心掛けている記述の方針と、そのような方針とした理由を簡単に述べます。
技術文書の「執筆態度」あるいは「心得」のようなものです。
文章を推敲する際のテクニックとして、一文を短くするなどの「表現のチェック」はしばしば目にします。しかし「内容のチェック」をする方法について言及した記事はあまり見かけません。
そのあたりを補足できればなと思います。
技術書や技術ブログを執筆することを念頭に置いていますが、口頭での説明にも応用できるかと思います。
この記事の内容は、あくまでも、当方の採用している記述の方針です。万人に役立つものではないかもしれません。
また、技術などの「情報を伝える」ことを目的とした文書のみを対象としています。情報を伝えることを目的としていないコミュニケーションを貶める意図はありません。
目次
- 記述の方針
- 記述の事例
1.記述の方針
私が文章を書くときに気を付けているのは、以下の4点です。
- 間違ったことをなるべく書かない
- 間違っていると指摘されたら、確認の上、なるべく早くに修正する
- 「常に真であることが明らか」というわけではない文章を書く
- 「間違っているのか否か」と「間違っているとしたら、それはどの箇所か」が判断できる文章を書く
記述方針4点セットは、「守ればすべてうまくいく」というものではないでしょう。
しかし「守っていなかったら問題だ」と私は思うので、自分の執筆態度を修正するのに用いています。
1番と2番に関しては、(実際にやるのは大変ですが)当然ともいえることかと思います。
3番と4番に関しては、あまり言及されることがないように思われますので、以下で簡単に補足します。
例えば、拙著『時系列分析と状態空間モデルの基礎』において、Box-Jenkins法について説明するとき、私は以下のように記述しました(一部抜粋)。
Box-Jenkins法は、時系列データを効率的に分析するためのフレームワークです。
以下の手順に沿って分析を進めていきます。
Step1:データを分析しやすくなるように変換する(中略)
Step2:データにARIMAモデルやそれに準ずるモデルを適用する
Step3 :以下略
私は、以下のような説明はしません。
Box-Jenkins法は、実務的な時系列分析を基礎づける体系であり、時系列分析の本質的手順を踏襲したものと言えます。
前者は、文章の特定の部分を切り出して、その内容に対する反論が可能です。
例えば『Box-Jenkins法は特定の分析モデルのことを指すので、フレームワークと呼ぶべきではない』と主張すれば、第1文に対して反論ができますね。あるいは『Box-Jenkins法で真っ先に行うべきことはARIMAモデルの次数の決定である』と主張すれば、Step1としてデータの変換を置いた私の主張に対する反論となります。
一方、後者の記述では、文章の内容に対して反論をするのがとても難しいです。
『実務的な時系列分析を基礎づける体系』や『時系列分析の本質的手順』という言葉が指し示す対象は、なんだかあいまいですね。
あいまいな表現を使わない、ということは大切だと思います。
しかし「あいまいな表現」とは何かと聞かれると、それ自体があいまいなので、なかなか答えにくいものです。
私は『「間違っているのか否か」あるいは「間違っているとしたら、それはどの箇所か」がわからない表現』を「あいまいな表現」という言葉の代わりに使っています。
さて、もっとひどい例を挙げてみます。『Box-Jenkins法とはBox-Jenkins法のことである』という主張は「常に真であることが明らか」です。しかし、この主張は、あまりにも正しすぎて、情報量がもはやありませんね。
このような文章をできる限りなくしたいと、私は思っています。
『Box-Jenkins法とはBox-Jenkins法のことである』は「常に真であることが明らか」な文章です。
『Box-Jenkins法は、実務的な時系列分析を基礎づける体系であり、時系列分析の本質的手順を踏襲したものと言えます』は「間違っているのか否か」あるいは「間違っているとしたら、それはどの箇所か」が判断できない文章です。
間違ったことを書きたいわけではないです。間違っているのか否かがわかる文章を書きたいのです。
反例を提示する余地のある文章を書きたいのです。
そのうえで、1つ1つの批判を吟味し、自分の文章に誤りがないことをチェックします。
これが、私の行う、技術文章の執筆プロセスです。
私自身、「文章の記述方針4点セット」が徹底されているとは思っていません。
いくつかの記事においては、間違っているのか否かがわからない、批判を受けにくくしたいという自分(著者)の心情が現れる文章が散見されます。
よほどひどいものは、これからも修正し続けていくつもりです。
もちろん「文章の記述方針4点セット」自体も、必要に応じて修正していきたいと思っています。
もっと良い方針があれば、是非教えてください。
2.記述の事例
原文
『運動は健康に良い』
この文章を対象として、修正をかけていきます。
あくまでも、私ならこうする、という1つの事例にすぎません。
大事なことですが「特定の文章に対する批判」をしたくて書いているわけではないです。
言葉狩りをしたい訳でもなく、特定の個人や組織を批判する意図もないです。
さて、『運動は健康に良い』という文章は「正しいかどうかを判断する情報が抜けている」文章です。
甲子園でしばしば問題になるのが、投手がボールをたくさん投げすぎてしまうことですね。ありえない話でしょうが、1日に1万球のボールを投げるという運動をすることは、間違いなく体に悪いです。
『運動は健康に良い』という文章は、運動の量など「どのような運動をするのか」という情報が抜けています。一口に運動といっても、公園の散歩をすることと太平洋をクロールで横断することには大きな違いがありそうです。
運動量によって、健康に良いこともあれば、健康に悪いと言えることもあります。
「間違っているのか否かが判断できない」文章なので、修正の必要があります。
書き換え例1
『適度な運動は健康に良い』
運動の量に関する言及が追加されました。
しかし、この文章にも問題があります。
「適度」という言葉は「ちょうど良い」という意味です。
上記文章は『健康にちょうど良い運動をすることは、健康に良い』と主張しているのと大差ありません。
いわゆるトートロジーですね。情報量がほとんどない文章であるといえます。
これは「常に真であることが明らか」な文章なので、修正の必要があります。
『良い結果を出すためには最善を尽くべきだ』とか『重要な情報を伝えるためには、本質を記す必要がある』とか、この手の文章は、私自身でも気づかぬうちに使ってしまうことがあります。
技術を伝えるのが目的である場合には、なるべく避けた方がいいと思います。
書き換え例2
『夕凪の上に立つ精霊のような軽快さで運動をすることは健康に良い』
当方が敬愛しております作曲家のエリック・サティ氏は、『卵のように軽やかに』という名言を残されております。どんな風に演奏すればいいんでしょうね。
これは一種の文学として大変優れたものであるし、一概に否定して良いかといわれると難しいところがあります。
とはいえ、『夕凪の上に立つ精霊のような軽快さで運動を』しているか否かの判断ができないので、技術書向きではないでしょう。
カッコイイと感じる物言いには注意が必要です。例えば『「善い行い」とは「魂の輝きが増すような行為」である』といった主張は避けたいです。
「善い行い」というわからないモノを「魂の輝きが増すような行為」というまた別のわからないモノに置き換えたところで、わからないことには変わりありません。「定義困難なものを、また別の定義困難なもので置き換える」という文章は、読者に情報を与えているとはいいがたい文章だと思います。
定義困難なものを対象としている以上、正しいか間違っているかの判断はできません。これは例えば『「rげfほうえwm」とは「んはんfさぢうhふぁ」のことである』という主張の正誤を判定できないのとよく似ています。少なくとも私は「んはんfさぢうhふぁ」が何を指しているのか全く分かりません。
「間違っているのか否か」が判断できない文章なので、修正の必要があります。
「文章の記述方針4点セット」に沿って修正した文章は以下の通りです。
書き換え例3
『18~64歳の人が、息が弾み汗をかく程度の運動を毎週60分行うことは、将来予想される「早世」「生活習慣病等への罹患」「生活機能の低下のリスク」を減少させる。
この運動量は、強度が3メッツ以上の運動を4メッツ・時/週行うことに相当する。』
なんだか友達をなくしそうな文章ではありますが、それはさておき、「文章の記述方針4点セット」は満たされていそうです。
頑張ったポイントは以下の通りです。
1.「どのような運動をするのか」という情報を追記した
2.「健康に良い」という言葉の意味を追記した
3.参考文献を追記した
情報を伝えるって、大変ですね。
とはいえ、ある一つの文章の中で「正しいとみなせる状況もあるし、間違っているとみなせる状況もありうる」というのはなるべく避けたいのです。
ちなみに、メッツという単位はあまり有名ではないので、実際に文章にまとめる場合には、その定義もどこかに書いておきましょう。
例えば『運動の強度は3メッツではなく、5メッツ以上が望ましい』と主張すれば、「運動の量が間違っている」という反論ができます。
例えば『「早世」「生活習慣病等への罹患」「生活機能の低下のリスク」ではなく、「アルツハイマー型認知症にかかるリスク」を低減できる』と主張すれば、「運動がもたらす効果が間違っている」という反論ができます。
反例を文章で提示できるというのが大切です。
先の文章も、まだまだ誤解を招く余地が残っています。
「早世」の具体的な年齢を記載するなどの情報の追加は常に検討の対象になります。
個人的には「生活習慣病等」というのが「様々な要素を含む言葉」なので、修正したいように感じます。様々な要素を含む言葉を使うことは、「どの箇所が間違っているのか」がわかりにくくなるので、あまりお勧めしません。具体的な病名をいくつか挙げた方が良いと感じます。
もしかしたら、私の読んだ文献が古くなってしまい、先の記述が間違ったものとなってしまうかもしれません。このあたりは、参考文献を示すことで、第三者が判断しやすくなります。
「間違っているか否かが判断できる」ので、修正すべきか否かの判断ができます。誤りだとわかった場合は、修正を行います。
ここで示した文章は、読みにくいかもしれません。
でも、ここがスタート地点だと思います。
「読みやすい文章」や「分かりやすい文章」を書こうと試みるよりも前に、「相手に伝えたい情報」を書き出しましょう。
少なくとも、私は、そうするように心がけています。
情報が多ければ多いほど読みづらくなります。
でも、読みやすいだけで、情報量が何もない文章を読みたいと思う読者は、特に技術書の場合は少ないはずです。
まずは先のような文章をスタート地点にして、情報を提示する順番を工夫したり、情報を小分けにして提示したり、読みやすさを向上させるための様々な工夫を凝らすことになります。
情報を減らすことも、もちろん検討の対象になります。この場合は「どのような情報を削ったのか」を記述するのが良いと思います。
たくさん情報があったものを削る、という執筆プロセスならば、何を削ったのかを把握しながら執筆できるのが利点です。
更新履歴
2019年8月12日:新規作成