📓

本質的ではないが重要なNotionドキュメンテーション作成テクニック

2023/02/23に公開

はじめに

みなさんはNotionを使っていますか？私は仕事でもプライベートでも活用しています。Ubieという私が所属している会社ではドキュメントは全面的にNotionを使用しており、仕事の細かなドキュメントや議事録から、外部に公開するためのカルチャーガイド(UPP)まで、様々なところでNotionが使われています。

ドキュメンテーションの本質は、とにかく文書を書くことです。その上で、それをどうやって人に読んでもらうか、意図を理解してもらうか、ということが次に来ます。読まれる場所に文書があったからといって、それが乱雑に言いたいことを書きなぐった文書だったり、短編小説レベルの長文であれば、それを人が上から下まで完璧に読んで理解してくれると期待することは酷でしょう。伝えたい内容が簡潔に記してあり、かつそれが読者の目を惹いてかつ読みやすい形になっていて、初めて伝わる文書であると私は思います。

そこで今回はNotionでドキュメントを書く際に、私が心がけているポイントや細かいけれども大事なテクニックを書き出してみます。

🖋 文章・構成編

文書において最も大事なことは、構造化されていることです。読者が暗に期待する通りに書いてあれば読みやすい文書になり、逆に言えば無造作だったり型を破った書き方をしていれば、それは読みにくい文書であると言えます。

目次（TOC)を使う

読者が文書の全体構造を瞬時に把握する一番の方法は、目次(TOC; Table of Contents)を見ることです。PCのいち画面に収まりきらないくらいのドキュメントであれば、必ず目次は付けるようにしましょう。

Notionでは/tocコマンドでページの目次を表示することができます。まずページを作成してタイトルを付けたら、目次を作成することを推奨します。

見出しを付ける

Notionの目次を活用するには、見出し(Heading)を付けなければいけません。H1,H2,H3と3つの階層の見出しを作成することができるので、文章構造に合わせて付けていくと良いでしょう。

それぞれの見出しは#,##,###というように、Markdownと同じ表記で作成できます。

箇条書きは必要最小限に

Notionに限らず、箇条書きはドキュメンテーションにおいて便利な記述方法です。一方で、その階層構造が適切でなかったり、過剰な箇条書きの連続は、読者にとっては認知負荷が高くなります。箇条書きは列挙が必要なときに限り、それ以外は平文として記述することをオススメします。

例として2つのパターンで簡単な文書を書いてみました。どちらのほうが読みやすく感じるでしょうか？

パターン1は全部箇条書きで書いたものです。議事録などでよく見ますよね。パターン2は箇条書きをなるべく少なく書き換えたものです。この文書くらいの内容であれば全編箇条書きのパターン1でもいいかもしれないですが、この箇条書きが10行,20行と長くなっていくと、文章構造を理解するのが難しくなっていきます。書いた本人は内容の構造を理解して正確に書いているつもりでも、読む側が文書から内容の構造を再構成する際に役立つとは限りません。ただ句読点の役割のように使っている余分な箇条書きは削除し、必要最小限に抑えるようにしましょう。

トグルは極力使わない

トグルとは文書の一部を折りたたむことができる機能ですが、これは極力使わないようにしましょう。理由としては、トグルによって文章が折り畳まれていることが視覚的に認識しづらく、またトグルを開くという操作を読者に強いるからです。人間は読み飛ばすことは得意ですので、適切に見出しが付いていて構造がわかっていれば、不要と判断すれば勝手に読み飛ばしてくれます。それでも文書が長くなりすぎて冗長に感じる場合は、トグルに折りたたむのではなく新しくページとして切り出すことを考えましょう。

ちなみに、トグルは折りたたむ文章があるかどうかで色がちょっと変わります。これを読者に意識させるのは、さすがに厳しいですよね。

🎨 デザイン編

Notionは何もしなくてもデザイン的にシンプルなドキュメントが作成できる一方で、工夫をしないとのっぺりとした単調な文書になってしまいます。装飾をすることはドキュメンテーションの範疇ではないと考える人がいるかもしれませんが、緩急を付けて読者の注意を適切に惹くことは大事であると私は思います。

ページには絵文字アイコンを付ける

Notionではページに絵文字やアイコンなどの画像を付けることができます。これはなるべく設定しましょう。このアイコンはページを表す視覚的な記号として、様々な箇所で使用されます。ページをタイトルの文言ではなく視覚的に覚えることができるので、特に多人数で編集が行われてかつページ数が多くなる仕事のワークスペースで効果を発揮します。

個人的に強く推奨する理由としては、文章の途中にページのリンクを貼り付けるときに、以下のようにアイコンが表示されるとパッと見たときにリンクが埋め込まれていることが分かりやすくなるからです。

アイコンを選択するのが面倒であれば、なにか自分の中でアイコン選択に制約を設けると良いと思います。私の場合は、パッと思いつくアイコンが無ければ動物か植物からランダムに選択するようにしています。

メッセージ枠を作る

文書中の補足や強調したいポイントは、メッセージ枠を作りましょう。Zennで言えば以下のようなものです。

これをNotionでも実現するには、絵文字と背景色カラーを使用します。以下のように幾つかのパターンを作っておくと、状況に応じて使い回せて便利です。

ポイントで罫線を配置する

あまり知られていない機能かもしれませんが、Notionでは罫線を挿入することができます。明示的にセクションを区切ったりと、視覚的に構造を表示する際に便利です。

Notionでは---と打つと罫線を挿入できます。

また、少し凝った使い方としては、見出しと併用することでよりデザイン的に視認性を上げることができます。ただし、あまり連発するとかえって邪魔に感じるので、ページのリンクをまとめたインデックスページであったり、H2の見出し程度におさめておきましょう。

まとめ

この記事では、Notionでのドキュメンテーションの際に私が意識しているポイントを紹介しました。私がNotionを気に入っているのは、今回紹介したテクニックくらいの遊びの余地がありつつ、巷の文書作成ツールのように何でもできるといった万能さが無いところです。複雑なことはできないという制約があるからこそ、文書を書くという本質的な行為に集中できます。どんどんドキュメンテーションを量産していきましょう！