みなさん、git使ってますか？
「別にチーム開発とかしてないしなぁ」
「そもそもプログラミングをあんまりしないし…」
ああ、もったいない！
個人での開発だとしてもgitには便利な機能がたくさんあるのに！！
別にgitはプログラムのソースコードの管理以外にも使えるのに！！！
ということで、今日はGithubを使ってより効率よく論文を書くために私が取っている方法を紹介します。
ただし、TeXで論文を書いていることが前提条件となります。
Word派の方はすみません…
また、今回はGitの基本的な使い方については省略します。
Gitを使った論文執筆のフロー
個々人によって多少の違いはあると思いますが、論文執筆開始から投稿までの大まかな流れは以下の通りだと思います。
- 書き上げる
- ボスにレビューを依頼
- 大量の赤が帰ってくる
- 修正開始
- 1に戻る
書き上げる
まず1のひたすら書く段階です。
初稿を書き始めるときは、masterではなく、”1st”などというbranchを作り、そこで編集を開始しましょう。
また、論文を書きながら、
「ここ参考文献欲しいなあ」
「このグラフ見辛いから後で直そう」
なんてことは多々あるかと思います。
そんなときはGithubの出番。
気付いてしまった問題点を、GithubのIssueといった形で残しておきましょう。
ボスにレビューを依頼
次に2のボスにレビューを依頼する段階ですが、
この時点で編集中のbranchからmasterに向かってPull Requestを送りましょう。
あなたのボスが新しい技術に理解のある方ならば、
Githubのコードレビュー機能を用いてもらうのが良いでしょう。
第二稿以降になったとき、前の稿との差分が非常にわかりやすくなります。
一通りレビューが終わったら、先程のPRを承認して、編集をmasterにmergeしちゃいましょう。
大量の赤が戻ってくる
次の段階です。
あなたの手元にはボスからの赤が付いた原稿があるかと思います。
この指摘を全てGithubのIssueに起こしてしまいましょう。
Issueのコメント欄はチェックボックスなどが使えます。TODOリストなどに活用しましょう。
修正開始
Issueを立て終わったら、次の稿を書き始めましょう。
このときに新しいbranchを作るのがミソです。
第二稿なら”2nd”、第三稿なら”3rd”という感じですね。
こうすることによって、あとから前の稿を振り返ることが容易になります。
「最初は何が言いたかったんだっけ？」
なんてときに便利です。
作業の可視化
色々と書きましたが、Githubを論文執筆に使う最大のメリットは作業量を可視化出来ることだと私は思っています。
こんな感じでコミット数のグラフを見ることも出来るので、
「今日は頑張ったなぁ～」
と感慨に浸り、低下しやすい論文執筆のモチベーションを保つことが出来ます。
最後になりますが、Githubのリポジトリは必ずprivateにしましょう！
ただ、privateにしたところで結局外部のサーバに保存していることには変わりないので、
大学内でgitlabのサーバを立てるなど、セキュリティ的な問題は各研究室できちんと考慮してくださいね。
