小さなドキュメントをコードの前に書く

細かいロジックまで書くわけじゃないよ

「ドキュメントはコードを書く前に書くんだ。だって、コード書いた後にドキュメントだけ書くなんて退屈だろ？」

分かる。

あとで書くんだったら、実装前に書いた方が色々コスパ良い。

実装方針が決まっているので実装がスムーズ

要件のぬけもれ、手戻りが減る。

レビュワーも方針が理解し易い。

なんなら、実装前にレビュワーに意見もらえる。

あとで、codeを読む人も理解しやすい

実装に至る結論には色んな要素があるので、それが明示化されていないと、なぜその意思決定をしたのかわからないことも多い。

リリース期限、人的リソース、システム課題とか

Next Action

小さなドキュメントをコードの前に書く

手間かかりそうに見えるけど、

テンプレート用意すれば、手間減る。

PR のDescriptionを先に書いているようなものだと思えば良い。