documentation

文書

文章を書くことについてのあれこれ
自分の思考を整理しておく,外部記憶として残しておくための文書,他人に見せてとある内容を伝える,理解してもらうための文書は違うもの.
そもそもいい文書とはなにか?
ドキュメントを書くときの「メンタルモデルの原則」にある,メンタルモデルを構築できるという考えは共感した.
メンタルモデルとは「これをするにはこうする,こうしたらこうなる」といったようにとある動作に対しての結果をイメージできる,見積もれる心のありよう.
その対象について色なことを推測できるようになるということ. 自分は読者の知っている知識の前提条件がメンタルモデルに該当すると思ってる.
文書を書く際に,読者がどれくらいのメンタルモデルを構築しているか(前提条件を満たしているか)に応じて文書を書く.
この部分を意識しないと,文書のまとまりが取りにくく,非常に手間となる.
実際に,同人誌を出す際に読者のメンタルモデルを設定しきれずに執筆を行ったためまとめるのが大変だった.
まえがきに対象読者のメンタルモデルを書いておくこともいいかもしれない.
また,対象となるメンタルモデルを構築していない場合,どうすればそのメンタルモデルを構築できるかの道筋を書いておくと読者にもやさしい.

新しい「公用文作成の要領」に向けて(報告)
公用文作成の考え方(建議)(付)「公用文作成の考え方(文化審議会建議)」解説

  • documentation.txt
  • 最終更新: 2024/03/24
  • by yuqlid