本文へ移動
cccskills
無料GitHub で公開

backward-compat-governance

後方互換性がゴミコードを量産する構造を検出し、互換性を「契約と撤去計画」として管理する ガバナンスを支援するスキル。公開API境界の明確化、非推奨化サイクル(deprecation cycle)の 制度化、互換層の局所化(Adapter/Strangler Fig)、契約テスト(CDC)による互換性検証、 AI生成コードの互換性ゲート設計を含む。コードレビュー、API設計、リファクタリング、 レガシー移行時に互換性起因の技術的負債を防ぐために使用。 対象言語: 言語非依存(Java, TypeScript, Go, Python, Rust等すべて)。 トリガー:「後方互換性を保ちたい」「非推奨APIをどうする」「互換層が増えてきた」 「レガシー移行の戦略」「API設計レビュー」「互換性のためのコードが多い」 「deprecation policyを作りたい」「破壊的変更の管理」といった互換性管理関連リクエストで起動。

インストール方法を見る

含まれるファイル(1)

  • SKILL.md8.8 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

後方互換性ガバナンス

互換性を「残すコード」ではなく「契約と撤去計画」として管理する。

核心原則

後方互換性それ自体が悪ではない。互換性を支える「仕様・テスト・撤去計画・計測」が欠けたとき、互換要求が実装へ流れ込みゴミコード化する。

状態互換性の扱い結果
管理あり契約(仕様)+ テスト + 撤去SLO + 計測安定性の基盤(資産)
管理なし実装でのその場しのぎ互換層の肥大化(負債)

負債化のフィードバックループ

既存クライアント → 「壊すな」の要求
  → 公開APIの固定・増殖
  → 非推奨APIの温存 + 互換アダプタ/分岐追加
  → 複雑性増大・テスト範囲拡大
  → 保守コスト増・変更速度低下
  → 期限圧力で近道実装
  → さらにAPI固定... (ループ)

判断フロー

互換性に関わる変更を検出
    ↓
公開API境界は明確か?
    ├─ NO → 境界を仕様化してから進む
    └─ YES ↓
非推奨化ポリシーはあるか?
    ├─ NO → ポリシーを策定(撤去SLO含む)
    └─ YES ↓
互換処理はどこにあるか?
    ├─ コードベース全体に散在 → 互換層を局所化(Adapter/Strangler Fig)
    └─ 局所化済み ↓
撤去計画はあるか?
    ├─ NO → 撤去タイムライン + 計測を設定
    └─ YES → 計画に従って進行

アンチパターン検出

以下のパターンを見つけたら互換性負債の兆候:

❌ if (version < X) { /* 旧挙動 */ } else { /* 新挙動 */ }  // バージョン分岐の散在
❌ @Deprecated が付いたまま何年も残るAPI
❌ LegacyXxxAdapter, OldXxxWrapper が増殖
❌ "互換性のため" というコメントが散在
❌ 同じ機能の新旧2つのエンドポイントが併存
❌ テストに "backward compat" 系のスキップ/無視がある
❌ 破壊的変更がドキュメント化されていない

対策パターン

1. 公開API境界の明確化

互換対象を限定し、不要な互換コードを防ぐ。

✅ 公開APIを仕様として宣言する(SemVer, OpenAPI等)
✅ 内部APIと公開APIを構造的に分離する
✅ 「何を壊さないか」のスコープを文書化する

❌ すべてのAPIを暗黙的に互換対象にする
❌ 内部実装の変更が外部に漏れる構造

境界の隔離例(Linux kernelの戦略):

  • ユーザ空間ABI: 極力壊さない(安定境界)
  • カーネル内部API: 自由に変更可能(進化可能)

2. 非推奨化サイクル(Deprecation Cycle)

撤去を制度化し、コード墓場を減らす。

非推奨宣言 → 移行期間(猶予SLO) → 利用率計測 → 削除
フェーズアクション成果物
宣言非推奨マーク + 代替案の提示非推奨注釈、移行ガイド
猶予移行支援 + 利用率追跡テレメトリ、移行状況ダッシュボード
削除利用ゼロ確認後に除去削除PR、リリースノート

猶予期間の目安(プロジェクト規模に応じて調整):

  • 内部API: 1-2リリースサイクル
  • 公開ライブラリ: 最低1メジャーバージョン
  • プラットフォームAPI: 2年以上(大規模エコシステム)

3. 互換層の局所化

互換処理を「コードベース全体に散らさない」ことが主戦場。

Adapterパターン: 非互換なI/F同士の差分を一点に集約

// ❌ 散在: あちこちでバージョン分岐
function processOrder(order: Order) {
  if (order.apiVersion < 2) {
    // v1の処理...
  } else {
    // v2の処理...
  }
}

// ✅ 局所化: アダプタで吸収
interface OrderProcessor { process(order: Order): Result }

class OrderV1Adapter implements OrderProcessor {
  constructor(private inner: OrderProcessorV2) {}
  process(order: OrderV1): Result {
    const converted = convertV1toV2(order)
    return this.inner.process(converted)
  }
}

Strangler Figパターン: レガシーを段階的に置換

旧システム ←→ [ルーティング層] ←→ 新システム
               ↑
         段階的に新へ転送を増やし、最終的に旧を除去

4. 契約テスト(Consumer-Driven Contract)

利用者の「使い方」に基づいて互換性を検証する。

✅ 消費者が使う部分だけを契約として固定
✅ 使われない挙動は自由に変更可能
✅ CIで互換性の回帰を自動検出

❌ "全部テストする" で範囲が爆発
❌ 互換テストがないまま「互換性を守る」と宣言

5. AI生成コードの互換性ゲート

AI出力を「未信頼入力」として扱い、互換性・依存性・安全性をゲートで縛る。

互換ポリシー/公開API定義
  → 参照ドキュメント/RAG
  → AI生成
  → 静的解析/セキュリティ検査 + 互換テスト/契約テスト
  → PR作成
  → 人間レビュー(互換・依存・撤去計画)
  → マージ
  → 互換メトリクス/非推奨利用率の監視

AI特有のリスク:

  • 非推奨APIの「それらしい」再生産
  • 存在しない依存パッケージ名の生成(package hallucination)
  • 互換層の無秩序な増殖(レビュー漏れ)

適用指針

推奨

  • @Deprecated / #[deprecated] が付いたまま長期間残るAPI
  • バージョン分岐がコードベース全体に散在
  • 「互換性のため」コメントが増殖
  • 破壊的変更のドキュメント化が不十分
  • レガシーシステムからの段階移行

過剰適用を避ける

  • 内部のみで使われるプライベートAPI
  • プロトタイプ段階で互換性が不要な場合
  • 互換対象のクライアントが存在しない新規API

レビューチェックリスト

API境界

  • 公開APIの境界が仕様として明確に定義されているか
  • 内部APIと公開APIが構造的に分離されているか
  • 互換性のスコープ(何を壊さないか)が文書化されているか

非推奨化管理

  • 非推奨APIに代替案が明示されているか
  • 撤去タイムライン(猶予SLO)が設定されているか
  • 利用率の計測手段があるか(テレメトリ等)
  • 非推奨APIの削除がリリース計画に含まれているか

互換層の設計

  • 互換処理が局所化されているか(Adapter等に集約)
  • バージョン分岐がコード全体に散在していないか
  • Strangler Fig等の段階移行戦略が検討されているか
  • Feature Flagを使う場合、撤去計画が設定されているか

テスト

  • 互換性の対象ごとに回帰テストがあるか
  • 契約テスト(CDC)が導入されているか(外部API/マイクロサービス)
  • 破壊的変更を検出する静的解析がCIに組み込まれているか

AI関与時の追加確認

  • AI生成コードが非推奨APIを使用していないか
  • 依存パッケージが実在するか検証されているか
  • 互換性テストがAI生成コードにも適用されているか

関連スキル(併読推奨)

このスキルを使用する際は、以下のスキルも併せて参照すること:

  • clean-architecture: 互換層を配置するアダプタ層の設計
  • repository-design: 公開API境界としてのリポジトリの互換性管理
  • intent-based-dedup: 旧API・新APIの意図的な重複を共通化しない判断

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

aggregate-design

無料日本語概要

DDDの集約(Aggregate)設計ルールに基づくコードレビュー・設計支援・リファクタリングを行う。 Evans Rules、Vernon's 4 Rules、Design by Contractに基づき、集約の境界定義、不変条件の検証、 不変(Immutable)設計、ID参照、結果整合性、ドメインイベント連携を包括的にガイドする。 以下のいずれかに該当する場合は必ずこのスキルを使用すること: - 集約(Aggregate)の新規設計・実装・リファクタリング(どの言語でも) - 既存の集約やエンティティクラスのDDD観点でのコードレビュー - 集約の境界決定(「AとBは同じ集約にすべきか?」「この集約は大きすぎるか?」) - 集約内の不変条件・整合性境界の設計 - 集約間の連携方式の判断(ドメインイベント、結果整合性、Sagaパターン) - 可変(Mutable)な集約コードを不変(Immutable)設計にリファクタリングする - publicフィールド、直接参照、push/appendなどカプセル化違反の検出・修正 キーワード例:集約、Aggregate、aggregate boundary、集約ルート、AggregateRoot、 エンティティ設計、DDD実装、Vernon Rules、Evans Rules、集約の分割、真の不変条件

j5ik2o/okite-ai802026年4月25日 更新

aggregate-transaction-boundary

無料日本語概要

集約とトランザクション境界の関係を明確化し、複数集約を単一トランザクションに含めるアンチパターンを 検出・是正する。集約は強い整合性境界であり、ユースケースで複数集約を更新する場合は結果整合性を 使うべきという原則を適用する。コードレビュー、ユースケース設計、リファクタリング時に トランザクション境界の問題を検出する場合に使用。 対象言語: 言語非依存(Java, Kotlin, Scala, TypeScript, Go, Rust, Python等すべて)。 トリガー:「複数集約を同じトランザクションで更新している」「ユースケースに@Transactionalがある」 「集約間の整合性をどう取るか」「Sagaパターンを使うべきか」「トランザクション境界の設計」 「1トランザクション1集約」「結果整合性の実装」「集約をまたぐトランザクション」 といったトランザクション境界関連リクエストで起動。

j5ik2o/okite-ai802026年4月25日 更新

breach-encapsulation-naming

無料日本語概要

getterの濫用を防ぐための命名規約スキル。ドメインモデルでgetterが必要な場合(永続化、JSON変換など)に `breachEncapsulationOf` プレフィックスを付与することで、カプセル化を破っていることを明示する。 これにより、Tell Don't Ask原則の違反を未然に防ぎ、getterの意図しない使用を抑制する。 コードレビュー、新規実装、リファクタリング時にgetter設計が必要な場合に使用。 対象言語: Java, Kotlin, Scala, TypeScript, Python, Go, Rust。 トリガー:「getterの命名規約」「カプセル化を破るgetter」「永続化用のgetter」 「breachEncapsulation」「getterを作りたいが濫用を防ぎたい」といったgetter命名関連リクエストで起動。

j5ik2o/okite-ai802026年4月25日 更新

clean-architecture

無料日本語概要

クリーンアーキテクチャを採用しているプロジェクト向けの設計・レビュー支援。4層構造(ドメイン層、 ユースケース層、インターフェースアダプタ層、インフラストラクチャ層)に基づく。特にインフラ層は 横断的関心事(ロギング、設定管理)のみ、永続化やRPCはインターフェースアダプタ層に配置すべき という原則を適用する。トリガー:「クリーンアーキテクチャで」「クリーンアーキテクチャに従って」 「クリーンアーキテクチャのレビュー」など、クリーンアーキテクチャを明示的に指定した場合のみ起動。 一般的な「設計レビュー」「アーキテクチャ相談」では起動しない。

j5ik2o/okite-ai802026年4月25日 更新

cqrs-aggregate-modeling

無料日本語概要

CQRS/ESが集約の境界定義とモデリングに与える影響を解説する。CQRSを導入すると集約は コマンド実行に必要な最小限の状態のみ保持すればよくなり、読み取り責務はリードモデルに 委譲できる。大きすぎる集約の軽量化、集約境界の再定義、イベントによる状態管理を支援する。 集約設計、CQRS導入時のモデリング見直し、パフォーマンス問題の解決時に使用。 対象言語: 言語非依存。 トリガー:「CQRSで集約が変わる」「集約が大きすぎる」「集約にメッセージ1000件」 「集約の更新が重い」「CQRS導入で集約を見直す」「集約を軽量化したい」 「集約にクエリ用データが混ざっている」「集約の境界を再定義」 といったCQRS/モデリング関連リクエストで起動。

j5ik2o/okite-ai802026年4月25日 更新

cqrs-to-event-sourcing

無料日本語概要

CQRSの実装においてイベントソーシングが必然的に必要となる理由を論理的に説明する。 C側からQ側へのデータ同期問題(計算された値の同期不可、トリガーの限界、ポーリングの スケーラビリティ問題、ダブルコミット問題)を段階的に分析し、イベントを真のデータソースに する設計への到達過程を示す。CQRS導入検討、アーキテクチャ設計時に使用。 対象言語: 言語非依存。 トリガー:「CQRSにイベントソーシングは必要か」「C側とQ側の同期方法」 「CQRSでモデルを分ける必要はないのか」「リードモデルの更新方法」 「なぜイベントソーシングが必要か」「ダブルコミット問題」「CQRSの同期問題」 「CQRSはESなしでも動くか」といったCQRS/ES必然性関連リクエストで起動。

j5ik2o/okite-ai802026年4月25日 更新

j5ik2o のスキルをすべて見る

このスキルの問題を報告する