シンプルで効率的な、ドキュメント作成の３ステップ（ドキュメントを最後まで書き切れないかたへ）

ドキュメントについて、よく下記のような質問をいただきます。

・文章を最後まで書ききれないのだけど、何かポイントはある？
・細かいところまで書きたくなって、どうしても長くなってしまう
・どういう順で書いたら良いの？

書きたいことはあるけれども、書き始めたら内容が散らばってしまいうまく着地できない、ということはよくあります。その結果、途中で書くのを辞めてしまったり、中途半端に公開してうまく伝わらなかったりしてしまう。

今回の質問のケースの場合にうまく解決できるように、私がドキュメントを書き始めるときに意識する3つのステップを紹介します。

目的を明確にする

まずは、ドキュメントの目的を明確にします。

「このドキュメントを書くことで、読者は何を知ることができるのか」「何のためにこのドキュメントがあるのか」という読者の疑問をとくために、目的を最初に明確にしておくことが大事です。

また、目的を明確にすると、文章が簡潔になり読みやすくなります。
一方で目的を曖昧にすると、必要以上の情報を書いてしまって、ついつい長くなってしまいます。

なお、目的はできる限り具体的に書くことをオススメします。

カレーの作り方を例にとると、目的を「おいしいカレーのつくりかた」とするよりは、
「30分でできる、野菜たっぷりビーフカレー」のほうが、より具体的になるので、書く際に迷わなくなります。

（「おいしいカレーの作り方」だと、ビーフなのかポークなのかベジタブルなのか、どの程度時間がかかるのか、など、文章が散らばりそうな予感がしてしまいます。）

章立てをする

目的が決まったら、次に書く内容の章立てをします。
章立てをすることで、読者が目的を把握しやすい、見やすい形にまとめることができます。
また、目的に応じて重要な情報を優先的に扱い、全体の構成を整理することで、ドキュメントが書きやすくなります。

章立てをする場合は、まずは項目を全て洗い出してから、順番に並べる作業をするとやりやすいです。

例えば「30分でできる、野菜たっぷりビーフカレー」という目的の場合、一旦項目をばーっと洗い出します。

- 材料を買う
- 材料を切る
- 調理器具を準備する
- 材料を炒める
- 材料を煮る
- 盛り付けをする

その次に、項目を手順に並び替え整理します。その際に、「準備」や「調理」などのカテゴリに分けて分類すると見やすくなります。

- 準備
  - 調理器具を準備する
  - 材料を準備する
- 調理
  - 材料を切る
  - 材料を炒める
  - 材料を煮る
  - ルーを入れて煮込む
- 盛り付け
  - ルーを盛り付ける

なお、このときに、詳しい内容は一切書く必要はありません。章立ての目的は、コンテンツを整理し、わかりやすい形にまとめることです。

肉付けをする

最後に、章立てした内容に肉付けをしていきます。
文章の肉付けとは、箇条書きや図表、実例などを加えて、文章をより具体的で理解しやすいものにすることを指します。これによって、読者はより明確なイメージを持つことができ、記事の情報を正確に理解することができます。

例えば、「材料を準備する」の場合だと、下記のような内容が必要になります。

- 必要な食材は何か
- 量はどの程度必要なのか
- 文章だとわからない場合、材料の写真が必要ではないか

こちらをふまえて肉付けしていくと、下記のような内容となります。

材料（６皿分）
カレーの材料を準備します。今回は6皿分の材料です。
  - 牛肉各切り：250g
  - 玉ねぎ：1個
  - ジャガイモ：3個
  - にんじん：1本
  - トマト：1個
  - カレールー：1/2箱
  - ニンニク：ひとかけ
  - サラダ油：大さじ1
  - 水：800ml

このように、各章立てごとに肉付けをしていき、ドキュメントを完成させます。

肉付けのポイントとしては、無駄なことは書かないというところです。
（当たり前ですが、「材料を準備する」の章では材料以外のことは書かない。）基本的なことなのですが、この点が出来ずに文章が散らばってしまっている人が結構いる印象です。

--🍛--

以上です。今回はドキュメントを書き切るための３ステップを紹介しました。
書きたい内容はあるものの、最後まで書ききれないという方のために書きましたので、少しでも参考になれば嬉しいです。