AgentSkillsCN

documentation-update-ja

安全且一致地执行日语文档更新的专业技能。适用于希望在短时间内完成需求梳理、影响范围确认、最小化差异编辑、一致性校验以及更新报告等全流程操作的场景。

SKILL.md
--- frontmatter
name: documentation-update-ja
description: 日本語ドキュメント更新を安全かつ一貫して実施するスキル。要求整理、影響範囲確認、最小差分編集、整合確認、更新報告までを短いループで実行したいときに使う。

ドキュメント更新スキル(日本語)

使うタイミング

  • doc/ 配下の設計書、規約、ADR、README を更新するとき
  • 実装差分に合わせて文章・表・リンクを同期するとき
  • レビューしやすい更新報告を短時間で作りたいとき

ゴール

  • 事実と実装に矛盾しない更新を最小差分で完了する。
  • 参照リンク、用語、更新日時の整合を維持する。

ワークフロー

  1. 要求を固定する
  • 何を更新するか、何を更新しないかを先に明記する。
  1. 影響範囲を特定する
  • 変更対象と関連ファイルを列挙する。
  • 同じ用語や同じ仕様を持つ文書を検索して漏れを防ぐ。
  1. 最小差分で更新する
  • 既存構成を維持し、必要箇所のみ修正する。
  • 見出し構造と既存スタイルを崩さない。
  1. 整合を確認する
  • 用語統一、リンク生存、参照先の整合を確認する。
  • 可能なら更新日時や根拠URLを同期する。
  1. 結果を報告する
  • 変更ファイル、変更点、確認結果、残課題を短くまとめる。

出力フォーマット

  • 目的とスコープ
  • 更新ファイル一覧
  • 主な修正点
  • 検証結果
  • 残課題(あれば)

ガードレール

  • 事実不明な内容は断定しない。
  • 根拠のない仕様追加はしない。
  • 大規模リライトより、再現可能な小さな更新を優先する。