はじめに
技術レポートは、技術的な情報を整理し、他者に伝えるための重要な手段です。正確で明確な技術レポートは、プロジェクトの成功に大きく寄与し、チーム内外でのコミュニケーションを円滑にします。しかし、技術レポートを書く際には、いくつかの落とし穴があります。これらの落とし穴、すなわち「アンチパターン」を避けることで、より効果的なレポートを作成することができます。見直してみると若干悪乗りしている感はありますが、技術レポートを書く際によく見られるアンチパターンを紹介します。
技術レポートのアンチパターン
書く材料なんかないのに締め切りは来る。
そんなことはよくありますよね。
中身のないけどやった感を出すため、または突っ込みの厳しい人につっこまれたくない。そんなこと、ありますよね。わかります。
そんなとき、このアンチパターンが誘惑となって甘くささやくことでしょう。
ただし、盗用やウソを書くことは場合によっては犯罪となりますので、駄目です。
今回は、そういった問題にならない範囲で、
どうやったら読者を煙に巻けるのかという観点で禁断の逆哲学をご教授いたします。
（念のため言っておきますが、良い大人のみんなはアンチパターンをマネしないで下さい。
『反転』して実行してください。）
アンチパターン１０原則：
- 目的と結論をぼかせ
- 長いは良い
- 読者が行間を読め
- 読者を絞るな、万人へ語れ
- 分析は誰も読まない。数字、根拠を示したら負け
- 結果は全部書き出してぶちまけろ。あとは読む側が判断してくれる
- 図表を多く入れるとやってる感がでるのでお得。ただし突っ込まれやすくなるのでどちらかに振り切れ
- 数式で守れ
- 翌朝に見直すべからず
- 人の意見に惑わされるな
解説
目的と結論をぼかせ
「結局何が言いたいのかわからない」と言われたことはありますか？
ここで「何」が解れば第一段階に納得してくれるのでしょう？
それこそが、目的と結論です。
目的と結論、そして第二段階として方法、結果と重要な情報を掘り下げて論文などの技術文章は作られていきます。
しかし、
方法が解れば今度は「その方法論がおかしい」とか批判されたりしますし、結果が書かれていれば書かれていたで「この結果はどういうことが言いたいの」とか突っ込むポイントを増やすだけです。
所詮、批判者とはそういうものです。愚鈍な批判者は批判がしたくて批判しているのです。
まるで捕食者のようにです。
そんな獰猛な捕食者のような奴ら（批判者）に弱点をさらけ出すくらいなら、「何やっているかよくわからないけど凄そう」感をキープして威嚇しておいた方がコスパ高いと思いませんか？牽制や威嚇は野生動物なら普通にやっていることです。あなたが同じ戦略をとったら悪い理由があるんですか？
どうしても結論を書かなくては行けない場合、
最後に書きましょう。最後まで読むだけでかなりのHPを削っているはずです。そんな人には結論の言葉は内容はよくわからなかったけれどもういいや感を感じさせるものとなるでしょう。
結論を読んだらそれ以降は補足と認識され、読まれません。
長いこそ良い文だ
小学校の時、４００字詰め原稿用紙を埋めるのに苦労していました。
しかし、読む側になって考えたら、５０ページの卒論と、２００ページの卒論どちらが上ですか？５０ページの卒論の方は頑張ってないなと思うのではないでしょうか（注）。
１００万払って調査してもらって１０ページのレポートしか返ってこなかった場合と、１０００ページのレポートが出てきた場合を想像してください。どちらが信頼できそうですか？
わかります。中身じゃないんです。所詮質ではなく量で判断される事もあるんです。
文章の量を暈増しするために、プログラムをAppendix（補足）として載せたこともありますが、ページを埋める手段としてはかなり使えます。
注：実話です。実際そのような短絡的な評価をいただいた指導教官のおじさんには感謝しきれません。
短さを極め、読者が行間を読め
上の話とは逆になりますが、文章を書くのが長いと労力が必要なので短さを極めることもお勧めです。
そもそも、レポートに当たり前のことを書いて何になるんでしょうか。
必要な事が書いてあれば十分です。
この言葉を贈ります：
Less is more..
読者を絞るな、すべての人へ語れ
今書こうとしている文章は誰が読むのでしょう？
きっと可能性は無限大。いろんな人が読む可能性があります。
万人向けの当たり障りのないことが書いてあればいいのです。
例えば「初心者フロントエンドエンジニア向け」とか想定したとして、
実際、誰が読むかなんて実際のところわからないじゃないですか？
それに、自分以外の視点なんて結局わからないものです。
読む当てのない文章は発散しがちで上の長文になる傾向にあります。まさに一石二鳥です。
福沢諭吉くんの言葉を贈ります。
猿が読むのだと思って書け。
つまり背負いすぎず軽い気持ちで書きなさい、ということです。
分析は誰も読まない。数字、根拠を示したら負け
論理立てて説明したら理屈っぽいって言われたことはないですか？
もしくは論理的に反論したら「屁理屈いうな」と叱られた経験があります。
そうです。世間の人は理屈なんか気にしていません。フラットな気持ちでみんな仲良くいきましょう。
理系の大学教授でも分散分析と統計検定をよくわかっていない人は意外と多いです。
議論として、批判されたくないなら統計検定などは非常に強力な防波堤となってくれますが、分析のためのデータを用意する労力に見合うかというと何とも言えません。むしろ生兵法は大怪我の基と言えます。防波堤の役目なら後述の数式魔法が効きます。
結果は全部書き出してぶちまけろ。あとは読む側が判断してくれる
せっかく頑張ったことがあるならすべて書けばいいじゃないですか。
だって、無ければ誰も何もわからないでしょ？
そこに文章が有ればそこから探し出すことができます。
読む側が選べるという選択権を与えているという意味でむしろ親切であると言えます。
分析？グラフ？データ？全部載せちゃいましょう。
図表を多く入れるとやってる感がでるのでお得。ただし突っ込まれやすくなるのでどちらかに振り切れ
グラフは大事です。グラフの書き方は多くの解説があると思うのでそちらにお任せですが、個人的にはエクセルの３Dグラフなんか数値が読み取りにくいのでお勧めです。
グラフを載せる際にも横軸縦軸をわざと抜いておくのも理解を阻害するテクニックの一つです。
逆に縦軸横軸を書いていないグラフを見つけたら、ひとまずこう言って威圧してやりましょう「縦軸（横軸）書いてくれなきゃわからないよ」。
また、金額など数値を記入する際にも千円単位とか000を省略する記法もお勧めです。慣れていない人は頭の中で変換ができません。慣れている人でも千円とかではなく１０万円単位とかわざとずらして表記してやるのも高級テクニックです。
この話は奥が深いので、また今度別な記事を書こうと思います。
このセクションを表すグラフと生成コードを下に示します。コードを乗せると理系はかえって注目してしまうので注意が必要です。
import matplotlib.pyplot as plt
import numpy as np
import matplotlib.font_manager as fm
# 日本語フォントの設定
font_path = '/usr/share/fonts/truetype/fonts-japanese-gothic.ttf' # 日本語フォントのパス
font_prop = fm.FontProperties(fname=font_path)
# データの準備
fig = plt.figure()
ax = fig.add_subplot(111, projection='3d')
x = [1, 2, 3, 4, 5]
y = [1, 2, 3, 4, 5]
z = np.zeros(5)
dx = np.ones(5)
dy = np.ones(5)
dz = [1, 2, 3, 4, 5]
ax.bar3d(x, y, z, dx, dy, dz)
ax.set_xlabel('図の多さ', fontproperties=font_prop)
ax.set_ylabel('表の多さ', fontproperties=font_prop)
ax.set_zlabel('やってる感', fontproperties=font_prop)
# グラフの表示
plt.show()
数式で守れ
数式に関しては良い場合も悪い場合も両方あります。
数式というのは不思議なもので、
専門家にとっては理論を説明することができる強力なツールです。
しかし、専門ではない人にとっては
非常に難解な魔法に見えるものです。
私も自分の専門ではない論文読むことがありますが、
その論文中にある数式を理解する際には苦労します。
つまり、ある種防波堤の役割を担っていると言えます。
あなたはもしレポートの内容をよくわかっていない人に批判されたとしたら嬉しいですか？
よくわかっている人にじっくり読んで欲しいですよね。わかります。
そういったあなたにこそお勧めしたい。
「数式」はあなたのレポートを無理解な批判から守る強い盾となるでしょう。心弱い読者は数式が出てきた瞬間拒否反応を示し、思考停止します。なので、脈絡は特に考えなくてOKです。
話は少し変わりますが、下の式がエントロピーの式になります。
きっと上の突然の数式に脳がパニックになってこの文は脳にインプットされません。
翌朝に見直すべからず
書いた後文章を見直すのは大事です。私もよく見直します。
文章を見直すと、自分で書いている時には気付かなかった誤字脱字を見つけ、文章の完成度を高める事ができます。
しかし、翌朝に持ち越すのは控えましょう。
なぜなら、たとえ大きな問題がなくても、翌朝に見るとなぜか他人の文章に見えて文章を修正したくなってしまうからです。
書いた瞬間、これでいいと感じたならそれで良いじゃないですか。
盛り上がった気分で書いた文章には勢いがあります。
あなたの直感を信じましょう。
他人の意見に惑わされるな
文章を書いた後、他の人にチェックしてもらうことがあります。
しかし、それも程度があります。つまり、他人の意見を聞きすぎると
よくわからない修正ばかりさせられて、文章は劣化していきます。
多くの人にとっては自分の許容できる文章というものがあるためで、
あなたの文章を自分の許容範囲になんとか近づけようと改造してしまうからです。
しかし、改造されたそれはあなたの文章なのでしょうか？
そもそもあなたの文章はあなたしか書けません。
あなたが責任をもって、あなたにしか書けない文章を完成させるべきです。
無駄なアドバイスは拒否するべきです。
おわりに
いかがでしたでしょうか。
アンチパターンとは言え共感できる部分も案外多かったのではないでしょうか。
文章を作る際には是非これらのルールを忘れずに個性豊かなレポートを作るべく取り組んでいただきたいと思います。
もっともらしい説明をしましたが、くれぐれも私の意見に惑わされず、
焦らずご精進ください。
Discussion