文章の書き方
前提
メモとして残した技術情報を元に手を動かしたい
現状，メモを構成する論理要素は以下のとおりである．
- 目標の状態
- 前提状態
- 前提状態から目標状態を得るための変換プロセス
- 各状態の確認方法
問題
執筆した技術メモをもとに手を動かすことができない
なぜなら、読み手(執筆者も含む)が文章の論理構造を理解できないからである。
なぜなら、その論理要素間の関係を理解できないからである
課題
上記の通り，課題は論理要素間の関係を読み手に理解させることである
論理要素間の関係を読み手に理解させる
論理要素間の関係を読み手に理解させるためには、読み手に明確なメンタルモデルを形成させることが必要となる
そのためには，読み手に予想させた情報に沿って文章を展開することが必要となる
予想させた情報にそって文章を展開するためには，以下2つの条件を満たす文章を書く必要がある
- 段落単位で論理構成が整理されていること
- 段落内ですでに述べた既知情報をつなぎに新しい情報が展開されていること
施策
以下2つの課題を満たす文書作成手順を示す
- 段落単位で論理構成が整理されていること
- 段落内ですでに述べた既知情報をつなぎに新しい情報が展開されていること
段落単位で論理構成が整理されていること
以下の手順に沿って段落構成を決める
- 情報を分類する
- グループを正しく対応させる
- 情報の対応関係に不足がないか確認する
- 各パラグラフの展開順を決める
情報を分類する
まず，情報を分類する
まず，述べる情報を一覧にする．
一覧にした情報を一段抽象度の高い概念でグルーピングする
グルーピングされない情報については，ふるい落とす
グループを正しく対応させる
次に，グループ間で情報を正しく対応させる
まず，グルーピングした情報の論理関係を定義する
論理関係は，問題-課題-施策といった論理的な対応関係のことである
論理関係を有さない情報については，不要な情報としてふるい落とす
情報の対応関係に不束がないか確認する
次に，情報の対応関係に不足がないか確認する
定義した論理関係の中に結論まで達することなく途中で切れてしまっているものがないか確認する．
切れているものに関しては，その理由を追記する．
または，不要な情報としてふるい落とす
各パラグラフの展開順を決める
次に，パラグラフの展開順を決める
まず，適切な順序でグループを整理する
適切な順序とは，時間順や空間順，割合順などの順序である
次に，整理したグループの順番に要約文を書きパラグラフとする
この時以下の条件を満たす要約文を書く
- 具体的な単語を使う
- 肯定形で内容を表現する
- 被修飾語句と修飾語句の関係が明確になるように表現する
段落内ですでに述べた既知情報をつなぎに新しい情報が展開されていること
以下の手順に沿って各論の詳細を記述する
- 各要約文の結論の導出過程を整理する
- 結論までの導出過程をチェックする
各要約文の結論の導出過程を整理する
まず，各要約文の結論の導出過程を整理する
各導出は，以下の要素で構成する
この時，根拠となる情報は前段で述べた結論か提言的事実のどちらかの情報である
- 真とする根拠情報
- そこから導出する結論情報
- 結論を導出する論拠
- 根拠に対する反証
- 論拠に対する反証
結論までの導出過程をチェックする
結論までの導出過程をチェックする
具体的には，整理した導出過程に上記の要素がすべて含まれているか確認する
効果検証
以下の手順に沿って施策の効果検証を実施する
- 以上の手順に沿って技術文書を作成する
- 作成した文書を元に成果物を作成する(不具合修正も含む)
- 作成した成果物が期待通り動作するか確認する
