synapse-docs

Synapse ドキュメント

このスキルは、Synapse A2A のドキュメントをコードの変更と同期した状態に保ちます。

このスキルが有効になる場合

自動トリガー

1. コアモジュールのコード変更 - synapse/*.py、synapse/commands/*.py
2. プロファイルの変更 - synapse/profiles/*.yaml
3. テンプレートの変更 - synapse/templates/.synapse/*
4. プラグイン／スキルの変更 - plugins/synapse-a2a/**/*
5. 設定の変更 - pyproject.toml（バージョン、依存関係、エントリーポイント）

手動での実行

• /synapse-docs - ドキュメント全体をチェックして更新します

ワークフロー

フェーズ 1：変更の検出

コードが変更されたら、references/code-doc-mapping.md を参照して、影響を受けるドキュメントを特定します。

クイックリファレンス — よくあるパターン：

変更の種類	主なドキュメント	関連するドキュメント
CLI コマンド	README.md、guides/usage.md	guides/references.md、CLAUDE.md
API エンドポイント	README.md、guides/references.md	guides/enterprise.md
環境変数	README.md、guides/settings.md	templates/.synapse/settings.json
プロファイル設定	guides/profiles.md	CLAUDE.md
スキルの内容	plugins/*/SKILL.md	.claude/skills/、.agents/skills/（plugins/synapse-a2a/skills/ を編集し、sync で配布）

フェーズ 2：更新案の提示

影響を受けるドキュメントごとに、次の手順を実行します。

1. 現在の内容を読む
2. 更新する箇所を特定する
3. 必要最小限の変更を提案する
4. 承認を得るため、変更内容をユーザーに提示する

更新の原則：

• 既存のドキュメントのスタイルとトーンを維持する
• 影響を受ける箇所のみを更新する
• README.md は簡潔に保ち、詳細は guides/ に記載する
• 関連するドキュメント間の一貫性を保つ

フェーズ 3：関連ファイルの同期

主要なドキュメントを更新した後、必要な同期を確認します。

スキルの同期：

plugins/synapse-a2a/skills/ → .claude/skills/
plugins/synapse-a2a/skills/ → .agents/skills/

テンプレートの一貫性：

synapse/templates/.synapse/ should match documentation in guides/settings.md

フェーズ 4：一貫性の確認

一貫性チェックを実行します。

1. CLI コマンド - README.md ↔ guides/usage.md ↔ guides/references.md を比較
2. API エンドポイント - README.md ↔ guides/references.md を比較
3. ポート範囲 - README.md ↔ guides/multi-agent-setup.md ↔ CLAUDE.md を比較
4. 環境変数 - README.md ↔ guides/settings.md ↔ templates/settings.json を比較

ドキュメントのカテゴリ

ユーザー向け（優先度高）

ドキュメント	目的	更新頻度
README.md	第一印象、クイックスタート	機能変更のたび
guides/usage.md	使用方法	CLI／API の変更時
guides/settings.md	設定リファレンス	設定の変更時
guides/troubleshooting.md	問題の解決	新しい問題の発見時

開発者向け

ドキュメント	目的	更新頻度
CLAUDE.md	Claude Code の開発ガイド	アーキテクチャ／テストの変更時
guides/architecture.md	内部設計	コンポーネントの変更時
docs/*.md	技術仕様	設計の変更時

プラグイン／スキル

ドキュメント	目的	更新頻度
plugins/synapse-a2a/README.md	プラグインのインストール	プラグインの変更時
plugins/*/skills/*/SKILL.md	スキルの手順	機能の変更時

参照ファイル

ドキュメントの一覧とコードからドキュメントへの対応関係の詳細については、次を参照してください。

• references/doc-inventory.md - すべてのドキュメントとその役割の完全な一覧
• references/code-doc-mapping.md - ソースファイルとドキュメントの対応関係

特別なケース

バージョン更新

pyproject.toml のバージョンが変更された場合：

1. リリースノートを CHANGELOG.md に追加する
2. README.md のテストバッジを更新する必要があるか確認する
3. 必要に応じて plugins/synapse-a2a/.claude-plugin/plugin.json のバージョンを更新する

新機能の追加

大きな新機能を追加する場合：

1. README.md の機能一覧に追加します
2. guides/ に関連するガイドを作成または更新します
3. 開発ワークフローに影響する場合は、CLAUDE.md を更新します
4. 新しいガイドを作成した場合は、guides/README.md のナビゲーションに追加します

非推奨化

機能を非推奨にする場合：

1. 関連ドキュメントで非推奨であることを明記します
2. 必要に応じて移行ガイドを追加します
3. CHANGELOG.md を更新します
4. README.md のクイックスタート例から削除します