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、集約の分割、真の不変条件
deepresearch-readme
GitHub OSS向け README.md の作成・改善・レビューを支援する。What/Why/How to start/Help/Maintainers の軸で情報を整理し、最短で動かせる Quickstart と docs への導線を構成する。
READMEの新規作成、既存READMEの再構成、READMEレビュー、ドキュメント分割の判断時に使用する。トリガー:「READMEを作って」「READMEを改善して」「Quickstartを追加して」 「GitHub向けREADMEテンプレ」「READMEをレビューして」などのREADME関連リクエスト。
含まれるファイル(3)
- SKILL.md3.0 KB
- references/readme-review-checklist.md1.4 KB
- references/readme-template.md1013 B
SKILL.md(原文)
インストールする前に、エージェントに与えられる指示の中身を確認できます。
Deepresearch Readme
GitHub OSS向けREADMEを、短時間で「何ができるか」と「どう始めるか」が伝わる状態に整える。
進め方
- 前提を確定する。
- プロジェクト種別を特定する: ライブラリ / CLI / Webアプリ / GitHub Action
- 対象読者を特定する: 利用者 / 評価者 / コントリビューター
- READMEの目的を確定する: 新規作成 / 改善 / レビュー
- ファーストビューを構成する。
- H1にプロジェクト名を書く
- 1〜2文で価値を書く(技術スタック説明より先に価値を出す)
- Quickstartへの最短導線を置く
- 必要な主要リンクだけを置く(Docs、Issues、Releases)
- Quickstartを最短化する。
Requirements、Install、Runの順で3〜6行程度に収める- 実際に実行できるコマンドだけを残す
- OS差分が長くなる場合は
docs/installation.mdへ分離する
- 構成を仕上げる。
- セクションは以下を基本とする:
HighlightsQuickstartUsageDocumentationGetting helpContributingLicense- 詳細説明は
docs/に切り出し、READMEには相対リンクだけ残す
- 最終検証を行う。
- 5分以内に「導入→最小実行」までたどれるか確認する
- リンク切れ、前提バージョン、手順の古さを確認する
references/readme-review-checklist.mdで網羅確認する
出力テンプレート
README本文を作るときは references/readme-template.md のテンプレートを優先して使う。
レビュー方針
既存READMEをレビューするときは以下を優先する。
- Critical
- Quickstartが実行不能
- 必須情報(What/How to start/Help)が欠落
- READMEが巨大化し、開始手順が埋もれている
- Warning
- セクション順が読み手の意思決定順とずれている
- docsへの導線が弱い
- バッジやリンクが多すぎて価値が伝わりにくい
- Info
- 表現の簡潔化
- 例の追加(CLI実行例、最小コード例)
- FAQやトラブルシューティングへの導線追加
参照ファイル
- 実践チェックリスト:
references/readme-review-checklist.md - README雛形:
references/readme-template.md
レビュー
まだレビューはありません。使ってみた感想をお寄せください。
同じリポジトリのスキル
概要と使いどころ
集約とトランザクション境界の関係を明確化し、複数集約を単一トランザクションに含めるアンチパターンを 検出・是正する。集約は強い整合性境界であり、ユースケースで複数集約を更新する場合は結果整合性を 使うべきという原則を適用する。コードレビュー、ユースケース設計、リファクタリング時に トランザクション境界の問題を検出する場合に使用。 対象言語: 言語非依存(Java, Kotlin, Scala, TypeScript, Go, Rust, Python等すべて)。 トリガー:「複数集約を同じトランザクションで更新している」「ユースケースに@Transactionalがある」 「集約間の整合性をどう取るか」「Sagaパターンを使うべきか」「トランザクション境界の設計」 「1トランザクション1集約」「結果整合性の実装」「集約をまたぐトランザクション」 といったトランザクション境界関連リクエストで起動。
後方互換性がゴミコードを量産する構造を検出し、互換性を「契約と撤去計画」として管理する ガバナンスを支援するスキル。公開API境界の明確化、非推奨化サイクル(deprecation cycle)の 制度化、互換層の局所化(Adapter/Strangler Fig)、契約テスト(CDC)による互換性検証、 AI生成コードの互換性ゲート設計を含む。コードレビュー、API設計、リファクタリング、 レガシー移行時に互換性起因の技術的負債を防ぐために使用。 対象言語: 言語非依存(Java, TypeScript, Go, Python, Rust等すべて)。 トリガー:「後方互換性を保ちたい」「非推奨APIをどうする」「互換層が増えてきた」 「レガシー移行の戦略」「API設計レビュー」「互換性のためのコードが多い」 「deprecation policyを作りたい」「破壊的変更の管理」といった互換性管理関連リクエストで起動。
getterの濫用を防ぐための命名規約スキル。ドメインモデルでgetterが必要な場合(永続化、JSON変換など)に `breachEncapsulationOf` プレフィックスを付与することで、カプセル化を破っていることを明示する。 これにより、Tell Don't Ask原則の違反を未然に防ぎ、getterの意図しない使用を抑制する。 コードレビュー、新規実装、リファクタリング時にgetter設計が必要な場合に使用。 対象言語: Java, Kotlin, Scala, TypeScript, Python, Go, Rust。 トリガー:「getterの命名規約」「カプセル化を破るgetter」「永続化用のgetter」 「breachEncapsulation」「getterを作りたいが濫用を防ぎたい」といったgetter命名関連リクエストで起動。
クリーンアーキテクチャを採用しているプロジェクト向けの設計・レビュー支援。4層構造(ドメイン層、 ユースケース層、インターフェースアダプタ層、インフラストラクチャ層)に基づく。特にインフラ層は 横断的関心事(ロギング、設定管理)のみ、永続化やRPCはインターフェースアダプタ層に配置すべき という原則を適用する。トリガー:「クリーンアーキテクチャで」「クリーンアーキテクチャに従って」 「クリーンアーキテクチャのレビュー」など、クリーンアーキテクチャを明示的に指定した場合のみ起動。 一般的な「設計レビュー」「アーキテクチャ相談」では起動しない。
CQRS/ESが集約の境界定義とモデリングに与える影響を解説する。CQRSを導入すると集約は コマンド実行に必要な最小限の状態のみ保持すればよくなり、読み取り責務はリードモデルに 委譲できる。大きすぎる集約の軽量化、集約境界の再定義、イベントによる状態管理を支援する。 集約設計、CQRS導入時のモデリング見直し、パフォーマンス問題の解決時に使用。 対象言語: 言語非依存。 トリガー:「CQRSで集約が変わる」「集約が大きすぎる」「集約にメッセージ1000件」 「集約の更新が重い」「CQRS導入で集約を見直す」「集約を軽量化したい」 「集約にクエリ用データが混ざっている」「集約の境界を再定義」 といったCQRS/モデリング関連リクエストで起動。