沢山書き直したい。差分を確認したい。頑張った履歴を数値で残したい。Gitを実践的に利用して学びたい。
そんな思いから始まり、卒論提出までGitで管理しながらやりとげました。
これから論文をGitを使って管理しようと考えている人たちにこの記事が届いてほしいです。(特に、縦書きの人に)
構成
下記ツールを使いました。
エディタ : VSCode
ファイル形式 : mdファイル
gitストレージ : GitHub (private)
gitGUIアプリ : SourceTree
資料管理 : Notion
ファイル形式
提出形式が縦書き指定ということもありwordで使われるdocx形式が理想でしたが、gitHubでも閲覧・編集を可能にするためmd形式に落ち着きました。
SourceTreeではdocxファイルの差分も閲覧できるので、GitHubでの閲覧編集を考えていない場合はおススメです。バイナリファイルに対応してくれているsourcetree開発者に感謝!!
md形式なら論文に必須な「注釈、見出し、ルビ」にも対応しているので非常に書きやすかった。
以上のことから、スマホでも編集したいなら、mdがおすすめです。
エディタ
VScode
shift + ctrl + v
上記プレビューショートカットは必須。
また、プラグインをいくつか入れましたが、最終的に残ったのは2つでした。
- Markdown All in One （htmlタグをプレビューで認識させるなど）
- Custom MD PDF （PDFにしてくれる。推敲用に利用）
GitHub
スマホやタブレットでの編集に利用。（PC持ち歩いたから結局使わなかったけどね）
issueをtodoリストとしても使える （Notionつかったから使わなかったけどね）
Git
ブランチは、上記ブログ記事を参考に2つ作成して、一つを作業用(dev)、もう一つを先生に見せた後の節目用(release)と分けて利用。
○○章○○節 新規 or 加筆 or 修正 (詳細情報)
<利用例>
第二章 第一節 新規 (「涙」に関する描写整理)
全体 修正 (見出し後、空行追加)
※変更箇所の情報を優先すると、後で振り返り易いです。
※リポジトリはパブリックだめ！ 絶対！
マイナンバーカード情報を公開するのと同じくらいの行為
苦悩・改善
提出の度に、mdからwordにコピペが必要だった
コピペ時にルビ振り直し、一字下げ、<br>の改行置換といった無駄な作業が発生する。
手作業で見落としが発生しやすく、提出稿で何度か微妙な差分が生じてしまう。
なにより時間の無駄！
良かったこと
- 行単位のコミットがすごく便利。コミットのタイミングを考えなくていい。
- コンフリクト防止に、作業前のプル・こまめなコミットが大切だと学んだ。
プルの重要性が身をしてみて感じる。 - wordではできない任意のタイミングで変更履歴のコミット
- 変更履歴に名前が付けられる (同じくwordではできない)
- 一年近く掛ける長期プロジェクトだからこそ、コミット数という実績が励みになる。
結論
スマホで編集しないなら、docx形式で十分。というかむしろ推奨！
コピペはヒューマンエラー起こすし、時間の無駄。
習うより慣れよ