技術屋のためのドキュメント相談所・所長の開米です。

先日twitterで質問いただきました。

Q：教えてください。文書は書き始めたら最後まで書いてから、読み直ししたりする方がいいのか？　途中まで書いたら見直す方がいいのか・・・　自分は前者かなって考えてます。

「最後まで書く」のがどの程度のクオリティかによりますが、基本的には走り書きレベルのラフなのを短時間で「最後まで書く」ことをお勧めします。

あくまでも、「走り書きレベルのラフなのを短時間で」ですので、大幅に修正を入れるのが前提です。

たとえば文書を書くのに使える時間が１０あるとしたら、そのうちの１～２を使って走り書きレベルの全体像を書き、６を使って構成を考え、残りの2,3で文書としての仕上げをするイメージですね。

ちなみにこれは↓今度技術評論社から出す本の一節なんですが、文書作成のプロセスの上3つと最後の「文章を書く」は本来分けた方がいいです。 でもそれを知らないといきなり「文章」を書き始めてしまったりします。

「走り書きレベルのラフなのを書く」というのは、上図の上2つ、「必要な情報を集めて整理する」「何を書くべきかを決める」段階をやろうという話です。なので本当は箇条書きだけとか、キーワードの羅列だけとかでもかまわないんです。

■続いて第2の質問

Q：書き出すと途中で、前の部分の訂正を始めてしまうことがあります。
これってやっぱり、下書きがちゃんとできていないからですよね。
下書きのコツがあれば...教えてもらえますか。

下書きのコツをいくつか挙げると： 

1. 使うキーワードを全部挙げてみる
2. そのキーワードが想定読者に通じるかどうかを確認
3. そのキーワードを使う順番を考える
4. キーワードが想定読者に通じない場合、本文中で説明する場合と欄外脚注にする場合とあるのでどっちにするかを考える・・・ 要するに本題にあまり影響しないものは欄外へ

なぜ　3.キーワードを使う順番を考える　か というと、理由は２つ

• 知識の無い人に、知らない言葉を一度に二つ以上出してはいけないから
• これがロジックの依存関係になるのできちんと考えないとうまく行かないから

です

あと経験的に言うと、複雑な概念を説明するときでも、「一本真っ直ぐつながるストーリー」を見つけると説明しやすいことが多いので、「順番を考える」のが重要です。

「一本真っ直ぐつながるストーリー」の話はこういうとこにも書いてました

↓
一本真っ直ぐ通る流れを探すと構造化しやすい

以上です。質問はtwitterでもコメントでもメールでも、私に届く任意の手段でお寄せください。

→　開米へのお問い合わせ方法一覧