はじめに
開発・設計時に絶対といっていいほど行っていることがあるので
その方法をご紹介いたします。
それは、メモ書き（コメントアウト） してから開発をするというシンプルな方法です。
対象読者
- 未経験からエンジニア転職した方
- マルチタスクを強く求められる環境にいる方
- 物事をシンプルに考えたい方
- ロジックの整理が苦手な方
目次
概要
やることはとてもシンプルで、メモ書きするだけです。
APIの実装を例にとります。
実装したいことが明確にあれば、それをするためにはどのように順を追って開発すればよいのかというのが整理できます。
↓はほんのかんたんな例ですが、このような感じで、メモ書きしていきます。
（このような実装が本来あるかどうかはおいておいてください。）
// 数字でパラメータを２つ受け取る
// 受け取ったパラメータが同じ数値であれば和を求める
// 受け取ったパラメータが違う数値であれば差を求める
// 計算結果を json にして返却する
まずコメントアウトで実装の方針を決めて
「入り口から出口までの方針」 をざっと書くだけです。
この条件に気をつけないといけないなとか、複雑に考えすぎていたなとか気づくことができます。
考えていることを文字に起こすだけで思考の整理が案外できるものです。
また、実装の準備をこのようにすることにより実装するときにそれを一つ一つクリアするだけの状態をつくることができます。
何がいいか
- はじめに流れを決めてしまうのでそこからの実装で後戻りが少ない
- 足りていない要件・条件など意識されていなかったことが早い段階で気付ける
- ワーキングメモリを節約できる
などがメリットとしてあげられます。
まずは手順をまとめるために
Notion だったり VSCode に書いたりで思いついたことを羅列したりもすることよくあります。
他にも
- 機能開発するとき
- なにか新しいことを始めるとき
- 何からはじめるか悩んでいるとき
などあらゆるケースで有用だと考えています。
まとめ
- 「その目的を達成するためにどの順序でやるのか、どのような手段がありどのような手段を取るのか、どのような制約があるのかな」どを思いつくことをとにかくコメントしていく。
- 思考が整理されて後戻りが少なくなる。
- ワーキングメモリの節約になる。