制作ログつけると開発が捗った話
はじめに
お久しぶりです、筆者です。
ずいぶん久々の投稿になってしまいました…まさか半年もブログ投稿が開いてしまうとは。
半年の期間中は、お仕事の忙しさの合間に支援絵を描いたり、VOICEROIDの立ち絵を作ったりとそれなりに充実した日々を送ってましたが…。
特に一番楽しかったのは、こちらの「アンジェラ様デスクトップマスコット作成」でした。
aik0aaac.hatenablog.com
きっかけは、私の大好きなゲーム『Library of Ruina』のファン作品コンテストに応募するためでしたが…。
2Dアニメーション作成ツールや、新たなElectronのバージョンでのデスクトップマスコット作成、果てはVue3への知識の習熟などいろんな道なる経験ができて楽しかったです。
そんな未知の経験をして楽しい制作の日々ではあったのですが、如何せん初挑戦なことが多い&開発期間も比較的長く(3週間程度)。
熱し易く冷め易い筆者にとって大丈夫かなという形ではありましたが…。
とあるものをやっていくことで、モチベーションの維持ができたので。
今回はその「とあるもの」の(未来の自分も含む)布教記事となります。
(タイトルでお察しなところあるかもですがね…)
それではいきましょう。
制作ログをつけよう
筆者が当時行ったのは「制作ログ」の作成でした。
実際の制作ログはこちら(制作中は別の場所に書いており、こちらは公開用に少しアレンジしたものです):
aik0aaac.github.io
作業をしている間は常にこの制作ログを開き、ちょっとした発見や新技術に関する調べたこと、更には今後の開発予定の計画や煮詰まった時に自分の考えを吐き出すところとして使っていました。
言っちゃえば「作業ログ兼TODOリスト兼考えを整理する場所兼備忘録」みたいな感じです。
ここからは制作ログを書いてきてよかった点を書いていこうかと。
制作ログのよかった点
制作ログを書いてきてよかった点をまとめると、下記の様な感じです:
- 考えを整理する場があるおかげで、思想の転換が簡単にできた
- どこまでやったかの開発内容を簡単に思い出せた&モチベUPできた
- ブログ記事に残す際の参考文ができた
順番に見ていきましょう。
👍考えを整理する場があるおかげで、思想の転換が簡単にできた
先にも記した通り、私は制作ログを「作業ログ兼TODOリスト兼考えを整理する場所兼備忘録」という形で運用してましたが…。
特に「考えを整理する場所」として運用したのがかなりよかったかなと。
プログラミングしてて煮詰まった時や、どうしようもないバグにぶち当たって解決策が見えてこない時も…。
ひとまずそれまで調査したことややったことを書くことで「別の観点からの考え」を掘り出すことができたり、さらには「そのバグを回避するために別のやり方で実装する」といった発想の転換も起こりやすくなりました。
最悪自分で思いつかなくても、文章としてまとまっているものがあるので他の人にも相談しやすかったなと。
👍どこまでやったかの開発内容を簡単に思い出せた&モチベUPできた
筆者は本アプリは「お仕事が終了した後の時間」を使って開発していたのですが…。
そうなると、どうしてもまとまった時間を取りづらくちょこちょこと開発を進める羽目になります。
これまでの制作ログを書いてなかったときは「昨日どこまで実装したか」を思い出す手間がありましたが、このドキュメントがあれば「どこまで実装したか」が文面となっているため早く思い出すことができます。
なんなら書くことで自らの進捗がわかりやすく文章として起こされるので、ドキュメントを書く行為自体も思い出すコストの低下につながります。
更に、お仕事が長引き自分の時間が取れなかったり、旅行や外出に行って長期間開発ができなかったりすると…。
「自分はこれまでどこまで開発してたっけ…」というのを忘れてしまい、そのまま開発意欲が下がって何もしなくなる…なんてことが自分はよくあったのですが。
このドキュメントがあれば、「自分はこんな苦労を経てここまでやれたんだな」という達成感も感じることができ、自然と開発意欲にも火がついてくれました。
なお、途中からは作業開始した日付も書く様になりました。
このおかげで「◯◯日から◯◯日でここまで進化したんだなぁ」という自信もつく様になり、更にモチベーションは加速…と、非常に良いことづくめでした。
👍ブログ記事に残す際の参考文ができた
筆者は特に新技術に対して学んだ際は、その知見をブログに書き起こしたい欲が強く出るのですが…。
こうしたいくつもの新技術を掛け合わせて制作してしまうと、ブログに残したい内容が多すぎてどこからまとめようか迷ったりします。
(実際今も迷ってます…)
これまでの制作ログがなかったときだと、その参考にすべきものは「完成したコード」や「コミットログ」しかなく…。
完成したコードを見たとしても、それまで自分がたどってきたバグやエラー、そしてそれを解消する知見は辿り着くことができず。
結局、自分が得た知見を書き記すのに参考になる記憶を思い出せず何も書けない…なんて経験がちょいちょいありました。
しかし、それまで自分がどう開発してきたかの制作ログがあれば!
その内容を読むだけで、簡単に当時自分が得た知見を思い出すことができます。
このおかげでブログ記事に起こすのがグッとやりやすくなったこと…。
そして当時の自分の苦悩や苦痛が記載されていることから、「この苦労は是非後世に伝えたい」というブログ記事へ起こすモチベーションの向上にもなったなぁと。
(とはいえ、今回は得た知識が多すぎてまだまだブログにおこせてはいませんが…)
制作ログについてのよかった点はここまで、お次は悪かった点を書いていきます。
制作ログの悪かった点
制作ログを書いてきて悪かった点をまとめると、下記の様な感じです:
- ログを記載するのが面倒になる
- 雑に書きすぎると思い出せなくなる
順番に見ていきましょう。
👎ログを記載するのが面倒になる
上記よかった点で言った様に、煮詰まった時やバグに当たった時に「考えを整理する場所」として使えているうちは気にならないのですが…。
開発が思ったより順調で、コードを書くのが楽しい段階になってくると途端にこのログへ書く意欲が削がれてしまいます。
実際、筆者もコードを書くのが楽しい段階にてログをすっかりつけ忘れ、1日の終わりに「あれっログ書いてない…今日何したっけ…」となることは多々ありました。
とはいえ、そういうときはコードの成果がたくさん現れているケースが多く、その場合コミットログを見た方が思い出せたりするので…。
コミットログのURLをペタッと貼っておくだけで済ませたりと言った簡略化も行いました。
ただ、流石にコードだけでは自分がその時何を思って実装したかわからなくなるため…。
できればログは書いておいてもよかったのかも? とは思う次第です。
(この辺りは制作ログとの付き合い方にもよるかもですが)
👎雑に書きすぎると思い出せなくなる
筆者は割と筆まめなところが幸いし、制作ログについてもかなりみっちりと色々記載できたのですが…。
もし自分がここまで筆まめじゃなかったら、きっとかなり雑に書いてしまっていたかと。
そうなると、せっかく書いても全く思い出せない制作ログになっていたかもしれません…。
少なくとも開発に1ヶ月も離れてしまえば綺麗さっぱり忘れてしまうので、制作ログを書くときは多少面倒でもまめに書いたほうがいいのかなぁと思う次第でした。
おわりに
本記事では「制作ログ」を書きながら開発した際の、よかった点と悪かった点についてまとめていきました。
実は今回の制作ログについては、何の参考記事も当たらず「自らの考えで、制作ログを作ろう」と決心しました。
…が、今このブログを書いてる時点で「同じ様なことを書いている記事って他にもいっぱいありそうだな…」という考えにようやく至っています。
自分で考えやってみたときは「自分天才かよ！」と思いましたが、多分それは筆者の知識が足りないだけかもしれませんね…。
開発、おまけにお仕事でもないプライベート開発をする上でのこうした知識を収集してみるのも面白そうです。
独り言が長引きました…ともあれ、今回の記事はここまで。
それでは|дﾟ＊)
