[Session]: アーキテクチャ図と Provider 依存関係図は別物では無いですか？

[daichikuwa0618]

現状

現在だと Session 8 に割り当てられている https://github.com/yumemi-inc/flutter-training-template/blob/main/docs/sessions/state_management.md について。

アーキテクチャを見直し、ARCHITECTURE.md に記載する

という課題がありますが、その下の「ヒント」に riverpod_graph で生成された Provider の依存関係図が記載あり、良く考えずに見るとこのような図を作る課題に思ってしまうと感じました。

動機

同じくゆめみ社のオープンハンドブックに ARCHITECTURE.md はほとんど変更が不要な記載方法になっているか というページがあり、こちらには

• アーキテクチャの説明でなく、実装の説明になっていないか
  • 具体的なクラス名やファイル名を記載すると、リネームのたびに修正が必要になる

と記載があります。

個人的な感覚としても、アーキテクチャ図は各レイヤー同士の依存関係を俯瞰的に図示したものであり、特定のオブジェクトが出てきたり、アプリケーションに存在する全てのオブジェクトを網羅する必要は無いと感じます。

提案

本 Session の目的が私は見えていないので、具体的な方針は示せませんが、いくつか方法はあると思います。

• Provider の依存関係図も作成してもらいたい場合:
  • ARCHITECTURE.md には「アーキテクチャを概念的に図示したもの」と「Provider 同士の依存関係図」の 2 つを作成するという課題に変更 (指示を具体化) する
• Provider の依存関係図も作成しなくて良い (あくまで一例の意図だった) 場合
  • 「※ この Provider の依存関係図は riverpod_graph を利用して自動生成しました。」という文言に何かしら補足する
  • 別の図例に変更する。

[blendthink]

おっしゃる通り、アーキテクチャ図と Provider 依存関係図はまったく別物なので、変えたいです、、！
数名の研修課題を行っていて、完全にミスリードだったなと考えています。