はじめに
- この文章は、筆者がおしごとをしている中で気をつけているNotionのドキュメント作成術についてまとめ、記憶を整理するために作成されました。
- 内容は些細なものであり、特段大きなテクニックはありません。
- 参考にしてくれるとうれしいです。
0. ドキュメントを書く時の原則
読み手の認知負荷を下げる
ドキュメントは読まれるために書く。だから、できるだけ読みやすいように書く。
書き手の認知負荷も下げる
ドキュメントを書くのは面倒である。だから、できるだけ書きやすいように書く。
1. 最初にドキュメント概要を書く
ブレットを四つを使って、ドキュメントの一番最初に「ドキュメント概要」を書く。
- ブレット一つ目：このドキュメントの存在意義
- ブレット二つ目：記述していること
- ブレット三つ目：（あれば）重要な補足
- ブレット四つ目：読者に対して期待すること
例えば、チーム内の個人情報保護ガイドラインの冒頭に書く「ドキュメント概要」は以下のようになる
- このドキュメントは、データ分析チーム内における個人情報の取り扱い方針を確立し、個人情報を取り扱う社員の負担を軽減するとともに、 個人情報漏洩などの事業上のリスクを削減することを目的に作成された。
- このドキュメントでは、総務省ガイドラインによる個人情報の定義、社内における個人情報の定義、およびその取り扱いについて記述している。
- この文章で定められた方針は、全社レベルでの個人情報取り扱いガイドラインが作成されたのちに破棄され、再構成される想定である。
- このドキュメントは、現実世界における個人情報保護法関連、およびデータ基盤の利用状況に基づき更新されることを想定している。アップデートがあり次第更新すること。
ドキュメントの最初にドキュメント概要を書くと、以下のようなメリットがある。
- 書き手にとっての利点
- この文章で何をしたいのか、何の情報を伝えたいのか明確に文章化することにより、文章を書く方針がずれなくなる
- 読み手にとっての利点
- この文章が何の目的で作成されたのかわかるため、時代遅れになった場合に更新するかどうかの判断がしやすくなる
- この文章で伝えたいことが最初にわかるので、この文章を読むべきかどうかが最初にわかる
2. ブレットは三段まで
ブレットを使う際、四段以上は入れ子にしないようにしよう。
- ブレット一段目
- ブレット二段目
- ブレット三段目（←ここまでOK）
- ブレット四段目（←これ以上組み込むと読みづらい）
- ブレット三段目（←ここまでOK）
- ブレット二段目
経験則ではあるが、ブレットが四段以上入れ子になると読みづらさが急増する。四段以上になりそうになったら、段落を再構成しよう。
3. トグルは「閉じてても本筋には影響ない補足情報」を入れる
トグルは便利なので、見出しにされることがある。読みづらいのでやめよう。トグルを見出しに使いたくなったら目次をつけよう。
トグルの中にトグルがあるととても読みづらくなる。可能な限りやめよう。トグルを使うのは「閉じていても本筋には関係がない、補足情報」に限ろう。
4. 絵文字を使わない
ノンデザイナーズ・デザインブックには、以下の四つの原則が書かれている。
- コントラスト
- 反復
- 整列
- 近接
このうち「反復」の原則は以下のようなもの：
デザインの視覚的要素を作品全体を通して繰り返すことです。色、形、テクスチャー、位置関係、線の太さ、フォント、サイズ、画像のコンセプトなどを反復させることができます。反復は、組織化を促進し、一体性を強化します
『ノンデザイナーズ・デザインブック』P13
絵文字は恣意的に、何の法則もなく使われがちであり、「反復」の原則を侵犯する。可能な限り絵文字は使わず、別の方法での構造化を考えた方がいい。
