@ledsun blog

無味の味は佳境に入らざればすなわち知れず

設計ドキュメントを書いている 2

設計ドキュメントを書いている - @ledsun blog につづいて、設計ドキュメントを書いています。

docs.google.com

これから作る機能は大体わかっています。 しかし、複数のコンポーネントにまたがる機能追加です。 どういう順番で実装していくのが安全か、なかなか判断がつきません。 普段はSlackの分報に調査記録を残しながら進めるのですが、考えを整理するときは時系列形式はちょっと不便です。 そこで設計ドキュメントという形で書いてみました。

結果、依存されているモジュールから依存しているモジュールの順番で、ボトムアップで実装していくことにしました。

ドキュメントの最終形は考えずに、知ってる情報や調べてわかった情報をつぎはぎで書いていきました。 書いてみたら、割とオーソドックスな次の構成になりました。

実装箇所が洗い出せました。 実装箇所の依存関係も大体わかったので、ボトムアップで実装できるようになりました。

普段は、どうやって操作したいのかなかなか理解できないので、UIからトップダウンで実装していくことが多いです。 今回は、扱うデータの種類を増やす変更でUIの変更はあまり多くないので、ボトムアップで進めるのがよいみたいです。