tk_zawa Blog

Gitを辿るような超丁寧なハンズオン形式の記事を書いて得た知見(反省点)

December 09, 2020

なにをしたのか

HAL Advent Calendar 2020の14日目を担当し、
Nest.js + MySQL + Dockerで動くバックエンドサーバの作り方をハンズオン形式で0からすべて説明するなどした。

反省点

  1. 0から自分で書こうとした為、執筆期間がかなり伸びた(11/11 ~ 12/08)
  2. サンプルとなるコードを基に記事を書いてから動作確認してみて、、を繰り返していた結果、基となるコードがバージョンが古いなどの問題で書いたままでは動かないことが多々あった
  3. DBの仕様を後から修正することが何度かあり、書いていた記事の該当する内容を手作業で探して直す必要に駆られた

解決策

1. 0から自分で書こうとした為、執筆期間がかなり伸びた

もっと公式サイト等を引用して説明を端折る

2. 記事を書いてから動作確認してみて、、を繰り返していた

先に丁寧にコミットを刻んで完成させておき、そのGitを後から追いかけながら記事を書くようにする

3. DBの仕様を後から修正することが何度かあった

2 と同様に先に仕様決めて動確を取れ

良かった点

  1. ハンズオン形式で先に大まかな流れを大分類->中分類->小分類と書いて纏めていったことが、作業のスイッチングが多い中でかなり捗った
  2. 自分の注意力が冴えていた(後から修正する際の)
  3. ゴールできたこと