AgentSkillsCN

sync-docs

排查实现代码与文档之间的差异,并根据实现情况更新文档。用于维护规格说明书。

SKILL.md
--- frontmatter
name: sync-docs
description: 実装コードとドキュメントの差異を調査し、ドキュメントを実装に合わせて更新する。仕様書のメンテナンスに使用
argument-hint: "[対象ディレクトリ: sequence|specs|user-stories|architecture|development](省略時は全体)"

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

プロジェクトの仕様ドキュメントを実装コードと比較し、差異を修正します。

対象ドキュメント構造

text
docs/
├── sequence/           # シーケンス図(実装フロー)
│   ├── api/           # APIエンドポイント別
│   │   ├── post/
│   │   ├── portfolio/
│   │   ├── crm/
│   │   ├── chat/
│   │   ├── email/
│   │   ├── inquiry/
│   │   └── integration/
│   ├── web/           # Webフロントエンド
│   │   ├── blog/
│   │   ├── portfolio/
│   │   └── api/
│   └── admin/         # 管理画面
│       ├── posts/
│       ├── portfolios/
│       ├── inquiries/
│       ├── crm/
│       └── dashboard/
├── specs/             # API・DB仕様書
│   ├── api/           # API仕様
│   └── db/            # DB仕様
├── user-stories/      # ユーザーストーリー
│   ├── visitor/
│   ├── admin/
│   └── crm-user/
├── architecture/      # アーキテクチャ設計
└── development/       # 開発ガイドライン

引数による対象指定

$ARGUMENTS で対象を絞り込み可能:

引数対象ディレクトリ対応する実装
sequencedocs/sequence/apps/api/src/, apps/web/, apps/admin/
specsdocs/specs/apps/api/src/interface/rest/, packages/db/prisma/schema/
user-storiesdocs/user-stories/apps/web/e2e/large/, apps/admin/e2e/
architecturedocs/architecture/プロジェクト全体構成
developmentdocs/development/開発規約・ツール設定
(省略)docs/ 全体全実装コード

チェック項目

シーケンス図 (docs/sequence/)

チェック実装参照先
エンドポイントパスapps/api/src/interface/rest/*.ts
リクエスト/レスポンス形式packages/validation/src/
UseCase呼び出しフローapps/api/src/application/usecases/
Repository操作apps/api/src/infrastructure/repositories/

API仕様書 (docs/specs/api/)

チェック実装参照先
エンドポイント一覧apps/api/src/interface/rest/
HTTPメソッド・パスHonoルーター定義
バリデーションルールpackages/validation/src/
エラーレスポンスapps/api/src/interface/error-handler.ts

DB仕様書 (docs/specs/db/)

チェック実装参照先
テーブル定義packages/db/prisma/schema/*.prisma
リレーションPrismaスキーマの @relation
インデックスPrismaスキーマの @@index

ユーザーストーリー (docs/user-stories/)

チェック実装参照先
シナリオの実装状態apps/web/e2e/large/, apps/admin/e2e/
受け入れ条件E2Eテストのアサーション

作業手順

  1. 差異調査: Exploreエージェントでドキュメントと実装の差異を網羅的に調査
  2. 差異一覧作成: 発見した差異をカテゴリ別(クリティカル/中/低)にまとめる
  3. 修正実行: Editツールでドキュメントを修正
  4. サマリー報告: 変更内容を報告

差異の優先度基準

優先度説明
クリティカル実装と完全に矛盾エンドポイントパスの相違、存在しないファイル参照
情報の欠落・不足新規追加されたパラメータ未記載
表記揺れ・軽微な差異バージョン番号、フォーマット

修正方針

  • 実装が正: ドキュメントを実装に合わせて修正
  • 未実装機能: ## 今後の拡張 セクションに移動
  • 削除された機能: ドキュメントから削除(履歴はgitで管理)

出力例

markdown
## sync-docs 実行結果

### クリティカル(即修正)
- [ ] `docs/sequence/api/crm/customer-create.md`: エンドポイント `/api/crm/customers` → `/api/customers` に修正

### 中(要確認)
- [ ] `docs/specs/api/post.md`: `publishedAt` パラメータの記載漏れ

### 低(任意)
- [ ] `docs/architecture/overview.md`: Node.jsバージョン 20.x → 22.x