H
コード変更を自動でドキュメント最新化
by ht311
Gitのdiffからコードとドキュメントのズレを自動検出し、変更があった箇所のドキュメントだけを正確に更新できます。ファイル構成の追加・削除、処理フロー変更、API仕様変更に即座に対応します。 README.mdのアーキテクチャ図、spec.mdの詳細仕様と実装を常に同期状態に保つことで、チームメンバーが古い情報を参照するリスクを排除します。 変更内容を自動分類(新ファイル追加→ツリー更新、モデルフィールド変更→データ構造セクション更新など)し、更新対象を明確に特定できます。 開発リーダー・テックリード:コードとドキュメントの乖離を防ぎ、チーム内情報鮮度を保ちたい人 フルスタック開発者:コード変更と同時にドキュメント更新を効率化したい人 ドキュメント管理者:仕様書の更新漏れ防止し、単一の情報源を保ちたい人 ワークフロー: 1. git status・git diffでコード変更内容を把握 2. 変更されたソースファイル(main.py・config.py等)を読込、処理フロー・設定値の変更確認 3. README.md・spec.md等対象ドキュメント読込 4. コードとドキュメント照合、ズレ箇所のみ更新(削除機能は完全削除、新規追加は対応セクションに追記、変更挙動は実装に合わせて書き換え) 本プロジェクト固有ルール:アーキテクチャ図はmain.pyのasyncio.gather()に渡されているフェッチャーのみ列挙。ファイル構成はsrc/fetchers/追加・削除反映。記事ソース一覧はconfig.pyのRSS_SOURCESリストが正規。Gemini選定ロジック変更時はPREFERRED_TOPICS・フォールバックモデル等反映。
ドキュメント記事設計