第7章 UI操作と内部処理を結び付け、操作結果を追えるようにする

利用者の問いは、クラス名から始まらない

内部構造を整理しても、利用者が知りたいのは「何を操作すると、何が起きるか」である。クラスやモジュールの説明だけでは、画面上の操作から必要な情報へ到達しにくい。

そこで、UI操作、内部で実行される処理、結果の対応を整理した。操作から処理を追い、処理から対応する操作を確認できるようにし、内部視点と利用者の視点をつないだ。

操作＋の付いた項目を選ぶと、詳しい説明が下に表示されます。

詳しい説明

気になる項目を選ぶと、その役割や判断理由を確認できます。

UI操作

利用者が画面で行う操作と、表示される内容を確認しました。内部のクラス名だけでは利用者の質問に答えにくいため、画面から見た動作を調査の起点にしました。

呼出し

画面操作から、どのイベント・関数・クラスへ処理が渡るかをコードで追いました。UIと内部処理を結び付け、操作に関する質問から必要な仕様へ到達できるようにしました。

内部処理

呼び出された先の処理順序と条件分岐を確認しました。UI中心の仕様書では不足していた内部ルールを実装から復元し、操作と結果の対応へつなぎました。

実動作

コードから読み取った内容を実際のソフトウェアの動作と照合しました。AIの説明をそのまま確定せず、人が確認した操作・処理・結果の対応をKnowledgeへ組み込みました。

操作を起点に、処理と結果を確認する

操作と内部構造の対応をKnowledgeへ組み込み、RAGで参照できる形にした。利用者が内部の名称を知らなくても、操作に関する質問から、何が実行されるかを探せる構成である。

UIの画面説明だけを増やす方法では、内部処理との関係が残らない。逆に、内部構造だけを示しても、利用者が機能へ到達できない。両者を接続したことで、操作と結果を理解するための調査に使えるようになった。

次章では、この対応をQAで利用するため、知識の粒度と回答範囲を調整する。