apple-docs-index について
複数のAppleフレームワークについて、APIとドキュメントパスを一覧するインデックススキルです。開発者がトピックを閲覧し、詳しく取得するページを選ぶのに役立ちます。
主な機能
- 01複数のAppleフレームワーク索引
- 02APIとトピックの検索
- 03ドキュメントパスの確認
- 04詳細文書の取得方法
活用シーン
- 01利用可能なフレームワークAPIの閲覧
- 02特定のドキュメントパスの検索
- 03取得する詳細ページの選定
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ prisma-labs-dev/ apple-skills --skill apple-docs-indexインストール後、Claude Code で/apple-docs-indexを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
combine-index.mdhealthkit-index.mdswiftdata-index.mdxctest-index.mdxcuiautomation-index.md詳細
Apple ドキュメントインデックス
このスキルでは、Apple のフレームワークドキュメントのインデックスを提供します。以下の用途に使用できます。
- フレームワークで利用可能な API を確認する
- 特定のドキュメントへのパスを見つける
- 詳細なドキュメントをダウンロードするか判断する
利用可能なインデックス
| フレームワーク | ファイル | サイズ | トピック |
|---|---|---|---|
| SwiftUI | ../swiftui/swiftui-overview.md | 907KB | ビュー、モディファイア、ナビゲーション、状態 |
| XCTest | xctest-index.md | 55KB | テスト、アサーション、期待値 |
| XCUIAutomation | xcuiautomation-index.md | 58KB | UI テスト、要素、クエリ |
| UIKit | ../uikit/uikit-overview.md | 1.8MB | ビュー、コントローラー、コントロール、シーン |
| Core Animation | ../core-animation/core-animation-index.md | 80KB | CALayer、CAAnimation、CATransaction、レイヤーのサブクラス |
| HealthKit | healthkit-index.md | 312KB | ヘルスデータ、ワークアウト、記録 |
| Combine | combine-index.md | 153KB | パブリッシャー、サブスクライバー、オペレーター |
| SwiftData | swiftdata-index.md | 86KB | モデル、コンテナ、クエリ |
| Observation | observation-index.md | 3KB | @Observable マクロ |
使用方法
1. インデックスを確認する
# See what's in HealthKit
cat healthkit-index.md | head -100
# Search for specific topic
grep -i "workout" healthkit-index.md
grep -i "navigation" ../swiftui/swiftui-overview.md
2. ドキュメントのパスを見つける
インデックスファイルには、利用可能なすべてのドキュメントページが記載されています。各項目にはパスが表示されています。
- [HKWorkout](/documentation/healthkit/hkworkout)
- [NavigationStack](/documentation/swiftui/navigationstack)
3. より詳細なドキュメントを取得する
- 詳細ページが、インストール済みの Apple スキルのいずれかですでに利用可能か確認します。
- スキル名、説明、または
SKILL.mdのフロントマターを使って該当しそうなスキルディレクトリを見つけ、取得する前にローカルの.mdファイルを grep します。インターネットから新しいドキュメントを取得するよりも高速で、必要なコンテキストも少なくて済みます。 - インストール済みのスキルに該当ページがない場合は、同じパスを
sosumi.aiの Markdown ミラーで使用します。
たとえば、/documentation/healthkit/hkworkout は https://sosumi.ai/documentation/healthkit/hkworkout に対応します。
4. 見つからないフレームワークのインデックスを確認する
ローカルのインデックスに必要なフレームワークが含まれていない場合は、そのフレームワークの sosumi.ai インデックスを使用します。
https://sosumi.ai/documentation/{framework}
たとえば、https://sosumi.ai/documentation/foundation には、Foundation のパスを検索できる Markdown インデックスがあります。
Markdown ミラーを利用できず、環境で JSON を解析できる場合は、Apple の公開 DocC インデックスエンドポイントを使用できます。
https://developer.apple.com/tutorials/data/index/{framework}
有用なパスツリーは interfaceLanguages.swift[0].children の下にあります。
コメント
Markdown 対応