一時的なメモではなく、長く役立つノート、チートシートを作ろう
メモとノートの違い
「メモ」、Memorandum は、「覚え書き」「回覧状」といった意味であり、記録を他者に連絡したらじきに破棄されるモノ、という意味合いがある。「ポストイット」に書いて誰かに渡すような、簡単な情報伝達で、すぐ捨てられるモノだ。
一方「ノート」は「書き留める」意味であり、「メモ」よりももっと自分用に近く、書き留めて持ち続ける性質がある。「ノートブック」というように、情報をしたためてしばらくは持ち続けるモノだ。
「ノート」は「メモ」よりも生存期間が長く、「メモ」は一時的な情報に過ぎない、というのが、単語本来の意味に近い捉え方である。
であれば、個人で書き留めるモノは短期的な「メモ」ではなく、長期に渡って活用できる「ノート」にしていきたい。その方が費用対効果が高い。
フロー情報とストック情報
「メモ」と「ノート」を分ける考え方の一つに、「フロー情報」と「ストック情報」という考え方ができるだろう。
フロー情報は、日々流れていく寿命の短い情報。ストック情報は、いつでも探しやすいまとまった情報、といえる。「メモ」は「フロー情報」に近く、「ノート」は「ストック情報」に近い。
つまり、ストック情報として活用できるような記し方・書き方を心掛けると、それは「メモ」ではなく「ノート」になっていくワケだ。
書き始めやすく、全部検索できること
ノートを書く時に「どこに書いたらいいかな~」と迷うのは時間がもったいないし、カテゴリ分けは難しいと思うので、個人的には「日付別にファイルやシート等を分ける」のをオススメする。書く際にコストをかけないようにするのだ。
そして情報を探すときには、「grep
コマンドなどによる全文検索で探しやすいこと」を重視したい。
執筆する媒体は Excel だろうが Markdown だろうが何だろうが構わないのだが、「とにかく迷わず早く書けて」「全文検索できる」ことが重要だと考えている。
- 必要だと思った情報を単一の Excel ブックに記していき、「ブック全体を検索」で検索できるようにする
- 特定のディレクトリ配下に日付別の Markdown ファイルを作ってノートを取っていき、
grep
コマンドで検索できるようにする - 個人用 Wiki を作り、Wiki 付属の検索エンジンや Elasticsearch などを組み合わせて検索できるようにする
他人も使えるチートシートに昇華する
うまくまとめられたノートは不要な情報ノイズが少なく、必要な情報がすぐに取り出しやすくなっているモノだ。ある特定の分野における、キレイにまとまった情報を「チートシート」と呼んだりする。テスト前に作る「カンペ」と同じだ。
個人で読み返してもどういう意味だか分からなくなった「メモ」ではなく、読み直すことで同じように理解が取り戻せる「ノート」になるのがまずは大事なこと。そしてその先に、同僚やチームメンバがそれを読んでも同じように活用できる、共有できる知的財産としていけるとより良い。そうした、共有できるチートシートに昇華させられると、皆の作業効率が上がる。
よく、社内 Wiki などに「作業メモ」などといって個人的な「メモ」だけを残して作業を引き継いだと言い張る人がいたりするが、「メモ」である時点で長期的な有用性が低く、またこういう場合のメモは「他人への伝達」という意識が希薄な、自己中心的な文章に留まっていることが多い。5W1H といった基礎が記されていなかったり、前提知識とするコンテキストの説明がなかったりすると、やはり役には立たず、誰か別の人がリバースエンジニアリングしてノートを書き直すことになる。
共有できるチートシートに求められるのは、次のような要素だろう。
- いつ作成し、いつ最終更新したか分かること : 初版作成者・初版作成日、最終更新者、最終更新日はヘッダに書いておくと良い。あまりにも古いチートシートは注意して読めるようになる
- その情報の有効期限が分かること : 例えば「MySQL 5.7 で検証した内容です」などと書いてあれば、バージョンアップ後は注意して読めるようになる
- 他人が加筆修正しやすいこと : 社内 Wiki など、共同編集できるツールで執筆し、「本人でないと加筆修正がしにくいフォーマット」には仕立て上げないこと。皆に追記してもらい、充実させられると良い
- その資料内で記さない前提知識を明記する : 例えば「手順内で○○コマンドを使用しますが、このコマンドのインストール方法は本資料では説明しません。別資料『○○』を参照してください」のように案内することで、どこまでをその資料に書くか示す
- 読者に求める知識量や理解度などを明示する指標にもなる。未経験の新人向けに書くつもりがないのであれば「コマンドの詳細はググってください」などと書いて切り捨てるのも一つの手。どこまで分かりやすく書くことにコストをかけるかは天秤ではかろう
- 誰にでも再現性が高いこと : 自分のローカルマシンでしか実行できないような書きぶりにするのではなく、それを読めば誰もが同じ結果を得られるように書く
- 使用しているツールのバージョンは細かく記載し、実行するコマンドや手順は正確に記す
- 5W1H の中でも、手順を記す時に「Why」の情報を多めに入れておくと、「結局は○○がやりたいということだから、この手順はこう改変する」というように、環境差異があった場合もリカバリがしやすい
「ノート」よりも他者目線が強く、かつ「メモ」よりも長期的に残り活用できる「チートシート」が作れると、皆の役に立つだろう。
- 関連ブログ記事 : 2016-06-29 チートシートはどんなツールで作ったらいいのかしら。
- 関連ブログ記事 : 2017-01-10 「ノート」と「メモ」の違いを考える
- 関連ブログ記事 : 2018-05-12 「メモ」ではなく「ノート」を取ろう。僕の仕事でのノートの取り方・使い方
社内共有するだけでなく、技術記事としてブログを執筆するのも一つだ。コチラも、個人メモに終始するような省略した書き方は「未来の自分」のためにもならないので、他人に伝わるよう書くことを心掛けよう。
- 関連ブログ記事 : 2017-07-15 自分の日本語が他人に通じると思うな
- 関連ブログ記事 : 2017-08-03 技術ブログを書く時は可能な限り動作環境を細かく記載する
- 関連ブログ記事 : 2018-10-17 日本のエンジニアのゴミ記事問題に対する、個人でスキルアップする方法は「アウトプット記事でお金を稼ごうとしてみること」
- 関連ブログ記事 : 2018-10-18 技術系のネタを「ゴミ記事」にしないために注意すべき具体的なポイント