~fvknk97034/bk

技術関連の備忘録

プライベートな学習メモをGitHub Issueで実現する

概要

技術書や資格の勉強をしている際のメモに、GitHub の Issue を使ったところ、使い勝手は悪くなかったので、自分の使い方を紹介します。

対象

以下の全てを満たす人を想定します。

  • 手軽にメモをとりながら作業、勉強をしたい
  • でも外部に作業、勉強途中の雑なメモを公開するのは恥ずかしい
  • GitHub 使い方は最低限わかる

注意点

一般に想定されるGithub Issueの使い方とは異なるので注意してください。
以下は自分の自習用リポジトリでの実施を想定しています。

使い方

1. プライベートリポジトリを作成

ここでは人に見られるのが恥ずかしいので、プライベートで作成します。
すでに TIL リポジトリがあればそれを使っても問題ありません。

2. リポジトリの Issues タブから新規 Issue を作成

私の場合タイトルは読んでいる本のタイトルを入れています。
コメントには以下のように目標などを入れてみるもの良いかもしれません。

3. 疑問点や考えたこと、追加で調べたことをどんどん書き込む

2.で作成した Issue に疑問に思ったことや、考えたことなどを書き込んで投稿します。 自分は章・節などキリの良い単位で読んでることが多いので、その単位でコメントを追加することが多いです。

4. 一通り学習が終わったら Close する

Issues のリストで学習中の内容と学習完了した内容が混ざらないようにクローズしておきます。

メリット

現状感じているメリットは以下です。

  • その時気になったことを時系列でざっくりメモして残しておける
  • 誰にも見られないため、羞恥で手を止めることがない
  • 学習開始、終了が Issue の作成、クローズで意識せずに管理できる
  • スマホからも書き込めて、PC からも確認ができるので場所を選ばず勉強ができる

デメリット

デメリットとしては以下かなと考えています。

  • contributions に草が生えない
  • 人に見せない前提で書くので、メモの内容が雑
  • 人に教えることでより技術が身につくと考えると、学習効果としては微妙かも?

まとめ

巷では雑多なメモでも良いので公開すべきという言説もありますが、公開のプレッシャーで手が止まってしまうのは本末転倒だよなあと思い、上記の手段を取るに至りました。 多少なりとも自信がついてきたら、上記のようなメモも外へ出す方向に移行できればと思います。