ドキュメント更新スキル(日本語)
使うタイミング
- •
doc/配下の設計書、規約、ADR、README を更新するとき - •実装差分に合わせて文章・表・リンクを同期するとき
- •レビューしやすい更新報告を短時間で作りたいとき
ゴール
- •事実と実装に矛盾しない更新を最小差分で完了する。
- •参照リンク、用語、更新日時の整合を維持する。
ワークフロー
- •要求を固定する
- •何を更新するか、何を更新しないかを先に明記する。
- •影響範囲を特定する
- •変更対象と関連ファイルを列挙する。
- •同じ用語や同じ仕様を持つ文書を検索して漏れを防ぐ。
- •最小差分で更新する
- •既存構成を維持し、必要箇所のみ修正する。
- •見出し構造と既存スタイルを崩さない。
- •整合を確認する
- •用語統一、リンク生存、参照先の整合を確認する。
- •可能なら更新日時や根拠URLを同期する。
- •結果を報告する
- •変更ファイル、変更点、確認結果、残課題を短くまとめる。
出力フォーマット
- •目的とスコープ
- •更新ファイル一覧
- •主な修正点
- •検証結果
- •残課題(あれば)
ガードレール
- •事実不明な内容は断定しない。
- •根拠のない仕様追加はしない。
- •大規模リライトより、再現可能な小さな更新を優先する。