blueprint-curate-docs について
ライブラリのドキュメントやプロジェクト規約を、AI エージェント向けの再利用可能なルールにまとめる開発者向けスキルです。使い方や設定、注意点を調査し、簡潔な項目を `.claude/rules/` に保存します。
主な機能
- 01ライブラリ文書とプロジェクトパターンの整理
- 02使い方、設定、注意点の抽出
- 03再利用可能なルール項目の作成
- 04ルールディレクトリの指定
- 05手書きルールの上書き回避
活用シーン
- 01依存ライブラリの注意点を記録
- 02PRP 用にプロジェクト規約を整理
- 03`.claude/rules/` に文書セットを構築
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ laurigates/ claude-plugins --skill blueprint-curate-docsインストール後、Claude Code で/blueprint-curate-docsを入力して読み込まれたか確認します。
同梱ファイルREFERENCE.md
詳細
/blueprint:curate-docs
ライブラリやプロジェクトのドキュメントをキュレーションし、AI エージェント向けに最適化された .claude/rules/ エントリーを作成します。セッションに自動読み込みされ、PRP から参照できる、簡潔で実行可能な、注意点を踏まえたコンテキストをまとめます。
注: 以前のブループリントのバージョンでは、これらのエントリーを
docs/blueprint/ai_docs/に書き込んでいました。この場所は非推奨です。ルールは Claude Code にネイティブに読み込まれ、すべてのコントリビューターと共有されるため、キュレーションした AI コンテキストの標準的な保存先は.claude/rules/です。
使用方法:/blueprint:curate-docs [library-name] または /blueprint:curate-docs project:[pattern-name]
このスキルを使う場面
| 次のような場合にこのスキルを使います | 次のような場合は代替手段を使います |
|---|---|
| PRP/コンテキストの再利用に向けて、ライブラリの注意点を記録する | 単発のタスクのために生のドキュメントを読む |
| プロジェクトのパターンをルールとして明文化する | ライブラリを一度だけ使う |
.claude/rules/ の下にナレッジベースを構築する | 一般的なライブラリ調査を行う |
コンテキスト
- ルールディレクトリ: !
find . -maxdepth 2 -type d -name rules -path '*/.claude/*' - 既存のルール: !
find . -maxdepth 3 -path '*/.claude/rules/*' -name "*.md" -type f - ルールパスの上書き設定: !
find . -maxdepth 3 -path '*/docs/blueprint/manifest.json' -exec jq -r '.structure.generated_rules_path // ".claude/rules/"' {} + - 依存関係に含まれるライブラリ: !
find . -maxdepth 1 \( -name package.json -o -name pyproject.toml -o -name requirements.txt \) -exec grep -m1 "^$1[\":@=]" {} +
パラメーター
$ARGUMENTS を解析します。
library-name:ドキュメント化するライブラリの名前(例:redis、pydantic)- 保存先:
$RULES_DIR/lib-[library-name].md - または、プロジェクトのパターンの場合は
project:[pattern-name] - 保存先:
$RULES_DIR/[pattern-name].md
- 保存先:
$RULES_DIR は、docs/blueprint/manifest.json に structure.generated_rules_path が設定されている場合はその値、設定されていない場合は .claude/rules/ です。
実行
ドキュメントのキュレーションワークフローを最後まで実行します。
ステップ 1:対象を特定し、既存のルールを確認する
- 引数を解析して、ライブラリかプロジェクトのパターンかを判定します
$RULES_DIRを解決します(manifest のstructure.generated_rules_path。デフォルトは.claude/rules/)$RULES_DIRにこのライブラリ/パターンのルールがすでに存在するか確認します- 存在する場合 → その場で更新するか、スキップするか尋ねます
- プロジェクトの依存関係からライブラリのバージョンを確認します
ステップ 2:調査してドキュメントを収集する
ライブラリの場合:
- 公式ドキュメントの URL を見つけます
- プロジェクトのユースケースに関連する特定のセクションを検索します
- 既知の問題や注意点を見つけます(WebSearch:「{library} common issues」、「{library} gotchas」)
- WebFetch で主要なセクションを抽出します
プロジェクトのパターンの場合:
- パターンの実装をコードベース内で検索します:
grep -r "{pattern}" src/ - どこでどのように使われているかを特定します
- 規約やバリエーションを記録します
- プロジェクトから実際のコード例を抽出します
ステップ 3:重要な情報を抽出する
- ユースケース:このライブラリ/パターンをプロジェクトでどのように、なぜ使うのか
- 一般的な操作:最も頻繁に行う使い方
- 使用しているパターン:プロジェクト固有の実装(ファイル参照を含む)
- 設定:このプロジェクトでの設定方法
- 注意点:バージョン固有の動作、よくある間違い、パフォーマンス上の落とし穴、セキュリティ上の考慮事項
注意点の情報源:GitHub の issue、Stack Overflow、チームの経験、公式ドキュメントの警告。
ステップ 4:ルールエントリーを作成する
$RULES_DIR/lib-[library-name].md または $RULES_DIR/[pattern-name].md にファイルを生成します(テンプレートは REFERENCE.md を参照)。
手作業で作成されたルールは、決して上書きしないでください。 対象のファイル名がすでに存在し、このスキルによって生成されたものではない場合は、別の名前(例:lib-[library-name]-gotchas.md)を選ぶか、確認してください。
テンプレートのすべてのセクションを含めます:Quick Reference、Patterns We Use、Configuration、Gotchas、Testing、Examples。
全体を 200 行未満に収めます。
ステップ 5:コード例を追加する
以下のソースから、コピーしてすぐに使えるコードスニペットを含めます。
- プロジェクトのコードベース(実際のファイルと行番号を参照)
- 公式ドキュメントの例
- Stack Overflow の解決策
- 個人の実装経験
ステップ 6:タスクレジストリを更新する
docs/blueprint/manifest.json のタスクレジストリエントリを更新します。
jq --arg now "$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
--argjson processed "${ITEMS_PROCESSED:-0}" \
--argjson created "${ITEMS_CREATED:-0}" \
'.task_registry["curate-docs"].last_completed_at = $now |
.task_registry["curate-docs"].last_result = "success" |
.task_registry["curate-docs"].stats.runs_total = ((.task_registry["curate-docs"].stats.runs_total // 0) + 1) |
.task_registry["curate-docs"].stats.items_processed = $processed |
.task_registry["curate-docs"].stats.items_created = $created' \
docs/blueprint/manifest.json > tmp.json && mv tmp.json docs/blueprint/manifest.json
ステップ 7:検証して保存する
- エントリが 200 行未満であることを確認します
- すべてのコード例が正確であることを確認します
- 注意点に解決策が含まれていることを確認します
- ファイルを保存します
- ルールのパスを含めて完了を報告し、PRP から参照できるようにします
エージェント向けの最適化
| コンテキスト | コマンド |
|---|---|
| ルールディレクトリを解決する | jq -r '.structure.generated_rules_path // ".claude/rules/"' docs/blueprint/manifest.json |
| 既存のルールを一覧表示する | ls .claude/rules/ 2>/dev/null |
| ライブラリのバージョンを確認する | grep "{library}" package.json pyproject.toml 2>/dev/null | head -1 |
| パターンを検索する | src/ 内で grep を使ってプロジェクトのパターンを検索します |
| 素早く調査する | ドキュメントを取得する代わりに、一般的な問題について WebSearch を使います |
ルールのテンプレート、セクションのガイドライン、エントリの例については、REFERENCE.md を参照してください。