めんどくさがりでもできるVSCodeを使ったノートのとり方とドキュメント化について

commits4 min read読了の目安(約3900字 4

はじめに

以下の記事をよんで、自分と似てる部分と違う部分あるなぁと思ったので、自分もノートのとりかた・ドキュメント化のフローを整理してみる。
新しい技術を学習しながらNotionでメモをとり、Zennで効率よく記事化するフロー

自分の場合、非常に忘れっぽいから、ノートとったりドキュメントに残すのが必須だと思ってる。ただ、かなりのめんどくさがりなので、ノートのとり方とドキュメント化を習慣化するのに、そこそこ苦労してて紆余曲折あった。似たような人もいるんじゃないかと思うので、忘れっぽくてめんどくさがりな人向けに、自分的にしっくりきてる方法を紹介する。

1. 画面キャプチャしまくる。

はじめての作業をしたり、他の人に共有したかったり、わすれそうなものは、何も考えず、キャプチャしまくって保存してる。

Macのショートカットで十分かなとはおもうけど、Chromeのスクロールして見えない部分もフルでキャプチャしたいときとか、個人情報をぼかしたいときは、Chrome拡張のAwesome Screenshotを使ってる。いい感じ。ローカルなファイルも編集できる。

2. タブ閉じる前に、リンクを保存する

調べ物してると、無限にタブが開かれてくので、ある程度頭を整理できたら、参考にしたところをマークダウンっぽくコピーして、メモしまくる。Copy as Markdownってシンプルなプラグインを使ってる。Ctrl+Shift+Cを割り当ててる。たまに、ショートカットわすれるけど、適当に押してたら思い出せる。

コピーするときは、Clipyってアプリを使ってる。クリップボードの履歴に簡単にアクセスできる。スニペットも登録できる。無料でいい感じ。

日本の人が開発はじめたっぽい。ありがたや。
クリップボード拡張Macアプリ「Clipy」を公開しました - Qiita

3. VSCodeのVSNotesでノートを取る。

ここがこの記事のメイン。といいつつ、やってることシンプル。
VSNotesってプラグインを使って、ただノートを取るだけ。すごくシンプルなプラグイン。マークダウンの.mdファイルを指定のフォルダに日付+名前(オプション)で保存してくれる。名前はオプションなので、なくても問題ない。めんどくさいので、あまり真面目に名前をつけてない。ほぼほぼ、それだけのプラグイン。

あたらしいファイルを作るときは、Command+Shift+PVSNotes: Create a New Noteを選んでファイル作るだけ。普通にファイルを作るより名前を付ける必要がない分、爆速。

選定の基準は、ここら。

  • 起動が爆速
  • 環境依存が小さい
  • クラウドでバックアップ
  • 学習コストすくない
  • ショートカットをあんまり覚えなくてよい
  • できればマークダウン
  • Emacsキーバインドつかえる

VSNotesの場合、ショートカットキーを覚えなくてすむのが素晴らしい。VSCode使ってるから、そっちで覚えたショートカットを流用できる。ドキュメント化するときマークダウン使えば学習コストいらず。自分でマークダウンのファイルを名前つけて保存してくのと一緒ではあるんやけど、ファイル名をつけるのすらめんどくさいので、すごく便利に使ってる。

「クラウドでバックアップ」ってところは、Google Driveで管理してるフォルダをVSNotesのフォルダにすることで実現してる。Google Drive自体がアップデートのタイミングとかで、うまく動かないこともあるけど、そんなに困ってはない。

特にルールはないけども、ある程度、仕事のまとまりごとにファイルを作って、適当に運用してる。ほぼほぼ書き捨てやけど、少し長い文章をSlackに投稿する前に整理したり、共有用のドキュメントを書く前にすこし整理したりしてる。

画像ファイルをマークダウン内に、貼り付けたいときは、ここらを使ったりしてる。画像ファイルの管理めんどいので、そんなに真面目には使ってない。
Image preview - Visual Studio Marketplace
Paste Image - Visual Studio Marketplace

4. ある程度、区切りがついたら、ノートを見返して、整理してドキュメント化する。

正直、特に、書くことはないかも。区切りがついたら、ドキュメント化してる。
ドキュメント化すると、頭を整理できるし、情報共有できるし、いい事づくし。
なれても、それなりに時間かかるけど、習慣化できて、ストレスなくドキュメント化できてる。
ドキュメントの種類はこんな感じかなと思ってる。ログ・シェア・アピールに分類される気がする。

ログ

  • 設定ログ
  • 調査ログ
  • 作業メモ

シェア

  • ルール
  • 手順書
  • 仕様
  • 情報の整理(ポータルサイト的な感じ)
  • 議事録
  • 検討資料(ダメ元で試したこと、うまくいかなかったこと、考えたこと等も含む)
  • いままでに誰もやったことないこと(論文・特許等)

アピール

  • やってみた
  • 作ってみた

ドキュメント化については、自己流が増えてきたので、改めてドキュメントの書き方の本よんだり、他の人の記事見たりして真似しよかな。

5. Zennへの投稿 (2021/05/16 追記)

下記サイト見て、VSCode拡張Zenn Editorを入れた。
むちゃくちゃいいかんじ。
Zenn の執筆を支援する VSCode 拡張 Zenn Editor

Zennに投稿するコンテンツをgithubで管理できるのがそもそもすばらしすぎるけれど、negokazさんの作ってくれたVSCode拡張でさらに楽になる。

npx zenn new:articlenpx zenn previewを覚える必要なくなるのと、画像のアップロード先を探す必要なくなるのがとってもすばらしい。

おわりに

ノートのとり方とドキュメント化について、やってることは、これだけやけど、シンプルな運用で、それなりに満足してうまくいってる。

めんどくさがりなので、きちんとやろうとすると続かないので、これ以上は無理な気がしてる。まぁでも、これからも、ちょいちょい修正して続けていきたい。ストレスが減る方向にがんばりたい。

APPENDIX

VSCodeのVSNotesにたどり着くまでに、以下のノートを使ってきた。紆余曲折あったけど、現状が一番気に入ってる。

スマホからやと、Google Keepとかにメモを書くことはあるけど、最近そんなには使ってない。在宅勤務やから、手元にスマホしかないって状況がほぼないからかなぁ。

物理ノートは、たまに使うけど、近くにある紙を使って適当に書いて写真とっておわる。結局ドキュメント化するときに、文字にしたり図をかいたりするから、すぐ捨てたらいいかってなってる。残したい気持ちもあるけど、管理めんどくさい。

デジタルノート

  • Journler
  • Evernote
  • Emacs org-mode
  • OneNote
  • Google Keep
  • Dynalist
  • Notion

物理ノート

  • 分厚い実験ノート
  • 普通のノート
  • コピーの裏紙
  • モレスキン
  • 野帳

この記事に贈られたバッジ