僕がここ数年続けている技術メモの書き方をまとめていきます。
技術メモ自体はみんながやっていて、それぞれのやり方があると思いますが、
自分なりのやり方がある程度固まってきたので、ここで共有したいと思います。
これをやっていくと、僕の僕による僕のための最強の技術メモが出来上がってきます。
使用するツールについて
社内で情報共有するツールとして、esa、QiitaTeam、Notion・・などいろいろありますが、
ここでは自分だけのための技術メモの書き方を共有します。
したがって、以下のツールがあれば十分です。
- VSCode
- Git（GitHub）
実際にどうまとめているの？
実際にVSCodeで、以下のような感じで管理しています。
例えば、Rubyというフォルダの中に、Rubyに関連するメモをまとめています。資格試験の勉強の時に結構書いたので、Rubyのとこは比較的充実してます。
その中で、rbenv.txt について表示していますが、rbenvに関するインストール方法、アップデート方法など、rubyのバージョン管理方法についてまとめています。
カテゴリごとにフォルダでわける
カテゴリごとにフォルダを作成して、検索しやすいようにしています。
内容によっては複数カテゴリにまたぐこともありますが、
自分がひっかけやすい方のフォルダに入れます。
自分にわかりやすいように書く
メモは自分しか見ないものなので、自分にわかりやすいように書きます。
社内で共有するメモは、誰が見ても理解できるに書くことを意識すると思いますが、
自分がわかれば良いというレベルで書きます。
つまり、自分がわかりきっている内容は省略して書きます。
メモをまとめ始めると意外と時間を取られるものですが、
上記のようにすることで時間を短縮できますし、メモを書くハードルがグッと下がります。
学んだタイミングですぐ書く
新しいことを学んだら、すぐにメモを書くことを意識しましょう。
後に回すと絶対にまとめません。（ソースは自分）
内容は間違っていても良い
メモは自分しか見ません。間違えて恥ずかしい思いをすることがありません。
なんかよくわからんけどこういうことかな？ぐらいの意識で問題ないので、
とにかく書きましょう。
無理のない量にする
とはいえ、とにかくメモを書けば良いというものではないです。（どっちやねん）
教科書を写経のように書いて、理解しきれていないことをまとめても仕方がないです。
タイトルをつけて、その下に箇条書きぐらいがちょうど良いと思っています。
技術メモはGitで管理する
Gitで管理することで、技術メモをまとめるモチベーションにもつながります。
適度なところでコミットし「あぁ、こんなにまとめたんだな〜」って思うことで継続的にやっていくことが出来ます。
また、GitHubなどを利用することで、どこでも見れるというメリットにも繋がります。
ただし、技術メモに機密情報やパスワードなどを記載する場合は十分に注意しましょう。
実際に私も自分の技術メモはGitHubで管理していますが、
内容はあくまで技術だけにとどめて、機密情報などは含めないようにしています。
テキストで書く（マークダウン等は使用しない）
パット見で確認する情報量としては、やはりテキストが最強です。
きれいにまとめて印刷とかするわけではないので、
マークダウン等を使う必要はないかなと思います。この辺はお好みですが・・。
私も最初は、マークダウンでまとめようと思いましたが、
後で見たときの情報量が少なくてやめました。
ただ、見出しとか箇条書きとかはマークダウン記法を意識して書いてます。
最後に
皆さんのメモライフの参考になればと思います。
他にも自分はこうやってメモしてますーとかあれば、コメント頂けるとうれしいです。