技術記事における、網羅性とわかりやすさのトレードオフについて

お久しぶりです。最近はとある事情で技術記事を書くことが多く、慣れない作業に悪戦苦闘しつつも、新しい発見がいくつかあったりして楽しくやれています。

今回は、最近の発見の一つである、「技術記事における、網羅性とわかりやすさのトレードオフ」について書いてみようと思います。

沈黙のWebライティングによると記事を書くときに重要なのは「専門性・網羅性・信頼性」である。しかし、技術系の記事においては膨大な概念が相互に深く関係し合っており、網羅性を求めすぎると情報量が多くなりすぎたり、論理が入り組みすぎたりしてしまう。読者にとっては限られた範囲の中で新しい概念を獲得する方が良いだろう。つまり、技術記事には、網羅性とわかりやすさ(論理が入り組んでいないこと)の両方を目指す必要があるが、一方を尊重しすぎると一方がおろそかになるというトレードオフがあり、うまくバランスをとって落とし所を見つける必要がある、ということである。

全てを網羅するよりは、「1つの記事では1つの切り口で説明し切る」という覚悟が必要である。そして、そういう記事を複数読ませることで読者が最終的には全てを理解できるようにするほうが良いアプローチである。こういう問題意識のもとでライターが意識すべきことをまとめる。

- ライターは記事を書く前に全てを網羅的に理解するべきである。
- その上で、それに適切な境界線を引いて複数記事に分割するべきである。
- 適切な境界線とは、その境界線の内に凝集性があって、説明が中で閉じているということである。記事内の概念と、広く一般的に知られている概念を使って説明し切ることが大事で、記事外のリンクをできるだけ参照しないことが重要となる。
- 記事内で前提とすることをできるだけ少なくするべきである。
- どうしても記事外の複雑な概念を導入しなければいけない時は、多少正確性を欠いても、とりあえずのおおざっぱな理解をしてもらう方が良い。

以上が、今回言いたかったことです。私自身、技術記事を書き始めて間もないので、まだまだ手法を確立できていませんが、今後も色々と発見していって、進化していきたいなと思っています。是非、もっと良い考え方や手法があれば教えてください。