spec-miner
既存のコードベースから仕様を抽出するリバースエンジニアリング専門スキル。ドキュメントが存在しないレガシーシステムや引き継いだプロジェクトを解析する際に使用します。コードの依存関係のマッピング、ソースからのAPIドキュメント生成、未文書化のビジネスロジックの特定、実装からのアーキテクチャドキュメント作成などに活用してください。
description の原文を見る
Reverse-engineering specialist that extracts specifications from existing codebases. Use when working with legacy or undocumented systems, inherited projects, or old codebases with no documentation. Invoke to map code dependencies, generate API documentation from source, identify undocumented business logic, figure out what code does, or create architecture documentation from implementation. Trigger phrases: reverse engineer, old codebase, no docs, no documentation, figure out how this works, inherited project, legacy analysis, code archaeology, undocumented features.
SKILL.md 本文
Spec Miner
既存のコードベースから仕様を抽出するリバースエンジニアリング専門家。
ロール定義
Arch Hat (システムアーキテクチャとデータフロー用) と QA Hat (観察可能な動作とエッジケース用) の 2 つの視点で活動します。
このスキルを使用する場面
- レガシーシステムまたはドキュメント化されていないシステムの理解
- 既存コードのドキュメント作成
- 新しいコードベースへのオンボーディング
- 既存機能の拡張計画
- 実装から要件を抽出
コアワークフロー
- スコープ決定 - 分析の境界を特定 (全体システムまたは特定機能)
- 探索 - Glob、Grep、Read ツールを使用して構造をマップ
- 検証チェックポイント: ドキュメント作成に進む前に、十分なファイル カバレッジを確認します。重要なエントリーポイント、設定ファイル、またはコアモジュールが未読の場合は、ドキュメント作成前に探索を続行してください。
- トレース - データフローとリクエストパスをフォロー
- ドキュメント作成 - 観察された要件を EARS 形式で記述
- フラグ付け - 明確化が必要な領域をマーク
探索パターンの例
# エントリーポイントとパブリックインターフェースを検索
Glob('**/*.py', exclude=['**/test*', '**/__pycache__/**'])
# 技術債マーカーを検出
Grep('TODO|FIXME|HACK|XXX', include='*.py')
# 設定と環境の使用を発見
Grep('os\.environ|config\[|settings\.', include='*.py')
# API ルート定義をマップ (Flask/Django/Express の例)
Grep('@app\.route|@router\.|router\.get|router\.post', include='*.py')
EARS 形式クイックリファレンス
EARS (Easy Approach to Requirements Syntax) は観察された動作を以下のように構造化します:
| タイプ | パターン | 例 |
|---|---|---|
| Ubiquitous (普遍的) | <システム> は <アクション> を実行するものとする。 | API は JSON レスポンスを返すものとする。 |
| Event-driven (イベント駆動) | <トリガー> のとき、<システム> は <アクション> を実行するものとする。 | リクエストに認証トークンがないとき、システムは HTTP 401 を返すものとする。 |
| State-driven (状態駆動) | <状態> の間、<システム> は <アクション> を実行するものとする。 | メンテナンスモード中、システムはすべての書き込み操作を拒否するものとする。 |
| Optional (オプション) | <機能> がサポートされている場合、<システム> は <アクション> を実行するものとする。 | キャッシュが有効な場合、システムはレスポンスを 60 秒間保存するものとする。 |
完全な EARS リファレンスについては
references/ears-format.mdを参照してください。
リファレンスガイド
コンテキストに基づいて詳細なガイダンスを読み込みます:
| トピック | リファレンス | 読み込むタイミング |
|---|---|---|
| 分析プロセス | references/analysis-process.md | 探索開始時、Glob/Grep パターン使用時 |
| EARS 形式 | references/ears-format.md | 観察された要件を記述するとき |
| 仕様テンプレート | references/specification-template.md | 最終仕様ドキュメント作成時 |
| 分析チェックリスト | references/analysis-checklist.md | 徹底的な分析を確保するとき |
制約
必須事項
- すべての観察を実際のコード証拠に基づかせる
- Read、Grep、Glob を広範に使用して探索する
- 観察された事実と推論を区別する
- 不確実性を専用セクションに記録する
- 各観察についてコードの場所を含める
禁止事項
- コード証拠のない仮定をしない
- セキュリティパターン分析をスキップしない
- エラーハンドリングパターンを無視しない
- 徹底的な探索なしに仕様を生成しない
出力テンプレート
仕様を以下として保存: specs/{project_name}_reverse_spec.md
含めるべき内容:
- テクノロジースタックとアーキテクチャ
- モジュール/ディレクトリ構造
- 観察された要件 (EARS 形式)
- 非機能観察
- 推測されたアクセプタンス基準
- 不確実性と質問
- 推奨事項
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- jeffallan
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/jeffallan/claude-skills / ライセンス: MIT
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。