AgentSkillsCN

sync-docs

对比分析实现代码与文档差异,并根据实现情况更新文档。可用于计划书与规格书的维护。

SKILL.md
--- frontmatter
name: sync-docs
description: 実装コードとドキュメントの差異を調査し、ドキュメントを実装に合わせて更新する。計画書・仕様書のメンテナンスに使う
argument-hint: [docsフォルダのパス(省略可)]

ドキュメント同期(実装との整合性チェック)

プロジェクトのドキュメント(計画書・仕様書など)を実装コードと比較し、差異を修正してください。

対象ドキュメント

$ARGUMENTS が指定されていれば、そのパスのドキュメントを対象にしてください。 指定がなければ、以下の順でドキュメントフォルダを探してください:

  • docs/
  • documents/
  • プロジェクトルートの *.md ファイル

チェック項目

  1. 進捗状況: ステップやフェーズの完了状態は実装と一致しているか
  2. 機能一覧: チェックボックスの状態は正確か
  3. ディレクトリ構成: 記載されているファイル・フォルダは実際に存在するか
  4. 技術スタック: 使用ライブラリ・バージョンは正しいか
  5. 設定値: テーマ、リージョン、モデルIDなどの設定は実装と一致しているか
  6. ツール・API定義: 実装されている機能とドキュメントの記載が一致しているか
  7. システムプロンプト: 記載内容と実装が一致しているか

作業手順

  1. まず Explore エージェントを使って、ドキュメントと実装の差異を網羅的に調査
  2. 発見された差異を一覧にまとめる
  3. 差異がある箇所を Edit ツールで修正
  4. 最後に変更内容のサマリーを報告

注意事項

  • 実装が正で、ドキュメントを実装に合わせる方向で修正する
  • 未実装の機能は「Phase 2」や「今後の拡張」に移動する
  • 軽微な差異(未使用コードの残存など)も報告するが、優先度を明示する

次のステップ

ドキュメントを更新したら、グローバルナレッジベースへの反映も提案してください:

「ドキュメントを同期しました。プロジェクト固有でない汎用的な学びがあれば、グローバルナレッジベースにも反映しておく?(/sync-knowledge で更新できるよ)」