X(Twitter) Zenn GitHub RSS 共有

ドキュメントライティング 2 思想

作成日時:2025-08-11
更新日時:2025-08-14

ドキュメントライティングに対する私の思想を記載する。
以降の文書は、これらの思想に基づく手法を説明している。

2.1 伝わらない文章は悪文である

情報を伝えるために文章を書く。
情報が伝わらないならば、その文章に価値は無い。
なぜならば、目的を達成していないのだから。

2.2 しかし文章が意図通りに解釈されることはありえない

「意図通りに解釈された」場合は「そのように見える」だけである。(→私的言語論)
文章の絶対的な意味解釈は存在せず、解釈は読み手のコンテキストに依存する。
読み手の数だけ解釈が異なる。
1つの文書を不特定対数の相手に読ませるならばなおさらである。

だが、書き手の意図と読み手の解釈を近づけることができる。
書き手のコンテキストを読み手のコンテキストに注入(提示)すればいい。
似通ったコンテキストによる文章の意味解釈は似通る。

2.3 故にコンテキストを過不足なく提示する

文章の意味はコンテキストに依存する。

コンテキストが無ければ文章の意味を理解できない。
コンテキストが異なれば文章の意味の解釈は異なる。
命題が真か偽かはコンテキストに依存する。

「顔を赤くして大声でわめいている」
→怒っているのか、酒を飲んで上機嫌なのか。

文章を読んだときに発生する”why”は、コンテキストが適切に提示されていないサインかもしれない。
文章を書くときは”why”を発生させないようにする。
文章、段落の中で読み手にそのコンテキストを提示する。
かつタイミングも大事で、なるべく早い段階で提示する。

「明確な意思疎通」とは文章の判断を一致させるように努力することかもしれない。
完全に同一の判断は不可能でも、「判断の収束点」を見つけることはできる。

2.4 また読み手の認知負荷を上げてはならない

読解が困難な文章を書いてはならない。
情報を伝えられる文章であったとしてもである。
コンテキストが過不足なく提示していたとしてもである。
なぜならば、読解が困難な文章は読み手の知的生産を阻むため。

頭を使うべきはその文章の内容にであって、文章の読解そのものに頭を使わせてはならない。

次へ