api-style-guide について
APIドキュメントの作成とレビューを支援するスキルです。エンジニア、DevRelチーム、パートナー向けに、構成、用語、コード例、メタデータ、アクセシビリティ、ローカライズの規約を定めます。
主な機能
- 01言語、トーン、用語の規則
- 02エンドポイント構成と書式の規約
- 03コード例と認証処理の確認
- 04バージョンと提供状況のメタデータ
- 05アクセシビリティとローカライズの指針
活用シーン
- 01APIリファレンスやチュートリアルの作成・更新
- 02エンジニアやパートナーによる文書のレビュー
- 03リリース前のドキュメント一貫性の確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/api-style-guideを入力して読み込まれたか確認します。
詳細
API スタイルガイドのスキル
使用する場面
- API リファレンス、チュートリアル、SDK ドキュメントの作成または更新。
- エンジニア、DevRel、パートナーからのコントリビューションのレビュー。
- リリース前のドキュメントの一貫性監査。
フレームワーク
- 言語とトーン – 対象読者に合わせたトーン、用語集、使用禁止の表現。
- 構成 – エンドポイントや順序の規則、表のレイアウト、コードブロックの書式、エラーのドキュメント化パターン。
- コードサンプル – 命名規則、認証の処理、ページネーションのパターン、インラインコメント。
- メタデータとタグ – バージョンラベル、利用可能状況の注記、ベータ版フラグ、ロケールの表示。
- アクセシビリティとローカライズ – 見出しの階層、代替テキスト、スニペットの注釈、翻訳ガイダンス。
テンプレート
- リファレンス項目のテンプレート（説明、パラメーター、レスポンス、例、注記）。
- 前提条件、手順、トラブルシューティング、次のステップを含むチュートリアルのひな形。
- 環境変数、コメント、エラー処理が含まれていることを確認するコードサンプルのチェックリスト。
ヒント
- サンプルは実行可能な状態に保ち、メインのサンプルが別の言語の場合でも、curl での同等の例を提示します。
- チーム間で共有する用語については、用語集にリンクします。
update-api-referenceコマンドと併用して、出力の一貫性を確保します。
コメント
Markdown 対応