変更の種類から見る設計書を引く¶
扱うこと: 変えたフォルダ・ファイルから、確かめ・直すべき設計書・テスト・決まりを逆引きする対応表。扱わないこと: 設計書の中身(仕様そのもの)、決まり(AGENTS.md など)の全文。先に読むページ: 設計の概要。
コードやテストを変えるとき、どの設計書を確かめ・直せばよいかを、変えたフォルダ・ファイルから逆引きする。
変更の種類 → 見る設計書・テスト・決まり¶
flowchart LR
crawl["scripts/tebunko/indexer/<br>(クロール・取り込み・抽出)"] --> ixdoc["indexing/"]
fmt["scripts/tebunko/index/"] --> dtdoc["index-data/"]
search["scripts/tebunko/search/"] --> sedoc["search/"]
ui["scripts/tebunko/ui/・xaml/"] --> gudoc["gui/"]
core["scripts/shared/・tebunko/core/"] --> stdoc["structure/"]
workflow["tests/・tools/・.github/workflows/"] --> tedoc["testing/"]
ixdoc & dtdoc & sedoc & gudoc & stdoc --> rfdoc["reference/<br>(関数を足したとき)"]
| 変えたもの(フォルダ・ファイル) | 見る設計書 | 見るテスト | 見る決まり |
|---|---|---|---|
scripts/tebunko/indexer/(クロール・取り込み一覧・並列化・ファイル種別ごとの抽出) |
indexing/ | tests/tebunko/indexer/ |
AGENTS.md「ソースの分け方」 |
scripts/tebunko/index/(インデックスの形・場所・入れ替え) |
index-data/ | tests/tebunko/index/ |
AGENTS.md「ドキュメントの図」(形式を変えたら移行の手順も) |
scripts/tebunko/search/ |
search/ | tests/tebunko/search/ |
同上 |
scripts/tebunko/ui/・scripts/tebunko/xaml/ |
gui/ | tests/tebunko/ui/ |
AGENTS.md「ソースの分け方」(画面層は判断層・状態層に触らない) |
scripts/shared/・scripts/tebunko/core/ |
structure/ | tests/shared/・tests/tebunko/core/ |
AGENTS.md「ソースの分け方」 |
setting.config の読み書き |
structure/settings-file.md | tests/tebunko/core/ |
前の版と互換が無くなるときは PR タイトルに ! |
tests/・tools/・.github/workflows/ |
testing/ | tests/meta/ |
AGENTS.md「コミット前の検査と CI」「テストカバレッジの方針」 |
| 関数を足した・消した | reference/(部品ごとのページ) | — | — |
- 表にない変更(
README.md・.github/の英語版など)は、そのファイルの決まり(AGENTS.md「言語」)に従う。 - 前の版と互換が無くなる変更(設定ファイル・インデックスの形式・起動の仕方・配布物の構成)は、直した設計書に移行の手順も書く(
AGENTS.md「GitHub の運用」)。