エンジニアが自分用の小さな技術メモを残すべき理由とScrapboxの紹介
簡単に結論
- 何度も調べる手間を減らすために小さな技術メモを残すのは大事
- Scrapboxなら気軽に使えるようなUI/UXだからおすすめ
記事の背景
エンジニアとして働いていると、実際にコードを書いている時間よりも調査の時間が長いと思います。
新卒でエンジニアとして働き始めたときに、上司から「小さな技術メモを残す習慣をつけろ」と言われました。
いろんなツールを使って小さな技術メモをとってきたのですが、最終的にはScrapboxが一番しっくりきたので紹介したいと思い記事を書きました。
小さな技術メモとは
僕がこの記事で「小さな技術メモ」と言っているメモのイメージはこんな感じのメモです。
内容のジャンルとしては主に以下のようなものです。
なぜ小さな技術メモを残すがの大事なのか
働き初めの頃は小さな技術メモをあまり残す習慣がありませんでした。しかし以下のような問題が発生しました。
- 半年前くらいに同じようなエラーメッセージが出たんだけど全く思い出せない
- どこかに技術仕様のわかりやすいブログ記事があったんだけど思い出せない。
- 何回も同じようなコードを書くときに、毎回ググって5分くらいかかる
1個1個の時間は大したことないのですが、チリツモで時間が無駄になっていると感じていました。
Scrapboxに小さな技術メモを残すことで解決した
いろいろなツールを試した結果Scrapboxが一番使いやすく感じました。
Scraoboxのメリット
- フォルダの概念がないので、新しくメモを作るときに整理する必要がない
- 後からメモ同士のリンクを簡単に作って知識を整理できる
- 全体的に動作が軽いので快適に使える
このような感じで完全に自分だけのメモなので雑に書くことができます
Scrapboxを小さな技術メモに使うときに注意すること
Scrapboxはプライベートプロジェクトを作ることができます。
しかし
- 簡単にパブリックにすることもできてしまう
- あくまで個人的なメモ
なので会社の機密情報になるような情報は残さないようにしています。
インターネット上に公開されているScrapboxプロジェクトを見ているとグレーな情報が書かれていることがあるので気をつけた方がいいでしょう。
自作Alfred Workflowの紹介
小さな技術メモを残していく中で、
- ブックマーク作成
- Scrapbox内検索
が気軽にできると便利だったので自作のAlfred Workflowを作成しました。
一緒に使うと便利なのでぜひ使ってみてください。
小さな技術メモを残すのに試したツール
最後に一応試したけど、使わなかったツールを紹介します。
Github Gist
コードスニペットを残すのに使いましたが、以下の理由で要件にあいませんでした。
- 整理機能が充実していない
- ブックマークとか簡単なメモを残せない
会社のWiki
機密情報も気にせず書けるというメリットがありましたが、以下の理由で使いづらかったです。
- 技術メモはプライベートな勉強でも参照したり作成したりする。
- 転職したときに消えるのが痛い
Notion
フォルダの概念があって、整理するのが面倒に感じ使いませんでした。
