| name | walkthrough |
| description | コードベースやサブシステムの仕組みを、実際のコマンド出力付きで直線的に解説する文書を作る。読んでいないコードや、忘れたコードを把握し直すときに使う。 |
直線的なウォークスルー
コードの仕組みを、上から順に読めば分かる形で解説する文書を作る。
自分が書いたが読んでいないコード、時間が経って忘れたコードに効く。
手順
- まずソースを読む。 対象を探索し(サブエージェントに任せてよい)、
直線的な物語の順序を決める。読者がどの順で各要素に出会えば、後のものが
前のものの上に積み上がるか。
notes/walkthrough-<topic>.md を作る(全体なら walkthrough.md)。
- コードは手で貼らない。
sed -n '10,30p' <file> などのコマンドと、その
実出力を貼る。こうすれば引用が本物のソースと一致していることが保証され、
幻覚が混ざらない。uvx showboat が使えるなら showboat exec が確実。
- 重要なファイルを網羅する。何をしているかだけでなく、なぜその形なのか、
どう繋がっているかを説明する。
このプロジェクトで特に価値が高い対象:
- 設定モデル(RAM)を中心にした、シリアル → 検証 → 反映 → 描画 の流れ
resolveAction と dispatchAction の分離が、どこでトランスポート依存を
食い止めているか
- 起動時のストレージのフォールバック順序(SD → NVS → 内蔵デフォルト)
一度読めば、能力のある開発者が全体を理解できる文書になっていること。