A
ドキュメントと実装の乖離を検出・修正
by ando-ar
コードベースを走査して、README・CLAUDE.md・docstring・コメント等のドキュメントと実際の実装がズレている箇所を自動検出し、カテゴリ別に一覧表示します。 API シグネチャの乖離(関数名や引数の不一致)、依存ライブラリ情報の乖離、実行コマンドの乖離、ファイルパス・ディレクトリ構造の乖離、設定パラメータの乖離、CLAUDE.md 規約と実装の乖離など、6つのカテゴリで体系的に検出します。 検出した乖離をユーザーに提示し、対話しながら ドキュメント側を修正するか、実装側を修正するか確認してから更新します。 「ドキュメントが古くなっているのを知っているけど、何がズレているか全体把握できていない」という状況の人 README や CLAUDE.md と実装の乖離を一気に洗い出し、効率的に修正したい開発チーム Hydra 設定、MLflow experiment、環境変数、依存ライブラリなど複数の層でドキュメントと実装が分散している Python プロジェクトの管理者 3フェーズ: (1) Scan — README.md、CLAUDE.md、docs//*.md、src//*.py の docstring、pyproject.toml、dvc.yaml などを走査し乖離候補を収集。(2) Report — 乖離を A〜F のカテゴリ(API・シグネチャ乖離、依存ライブラリ乖離、コマンド・スクリプト乖離、ファイルパス・ディレクトリ乖離、設定・パラメータ乖離、CLAUDE.md 規約乖離)に分類して一覧表示。(3) Fix — ユーザーの確認を取りながら修正。 検出対象の詳細: 公開 API、関数シグネチャ、クラス定義、docstring のパラメータ記述(:param, Args, Returns, Raises など)、pyproject.toml の dependencies と README の記載の対比、Makefile/justfile のターゲット、相対パスの存在確認、Hydra 設定キー、MLflow experiment 名、環境変数パターン。除外: node_modules, .venv, __pycache__, .git, mlruns, htmlcov。
テストドキュメント設計