API認証ドキュメント作成スキル

概要

認証フローの図解、トークン取得手順、セキュリティ注意点を整理して、読み手が実装できる状態にする。 必要な詳細は references/ に外部化し、必要時に参照する。

• クイックスタートは assets/auth-quickstart.md
• 図解は assets/oauth2-diagrams.md

ワークフロー

Phase 1: 目的と対象フローの整理

目的: 認証方式とドキュメントの対象範囲を明確化する

アクション:

1. references/Level1_basics.md で基本概念を確認
2. 対象フロー（OAuth/API Key/JWT）を整理
3. 読者の前提知識を整理

Task: agents/define-doc-scope.md

Phase 2: 図解と手順の作成

目的: フロー図解と実装手順を作成する

アクション:

1. references/oauth2-flows.md でフロー仕様を確認
2. assets/oauth2-diagrams.md で図解を作成
3. references/token-management.md でトークン説明を補強
4. assets/auth-quickstart.md をベースに手順を作成

Task:

• agents/create-flow-diagrams.md
• agents/write-quickstart.md

Phase 3: セキュリティ確認と仕上げ

目的: セキュリティ注意点と品質チェックを行う

アクション:

1. references/security-best-practices.md で注意点を確認
2. scripts/test-auth-endpoint.sh でサンプルを検証
3. scripts/log_usage.mjs で改善記録を残す

Task: agents/review-security-notes.md

Task仕様ナビ

ベストプラクティス

すべきこと

• 読者の前提知識を明確にする
• フロー図と手順を必ずセットで提示する
• トークンの有効期限と更新手順を明記する
• セキュリティ注意点を別セクションで整理する

避けるべきこと

• シークレットや実キーを例に含める
• 図解のみで説明を省略する
• 方式を限定して他方式の選択肢を隠す

リソース参照

参照資料

• references/Level1_basics.md: 基本概念
• references/Level2_intermediate.md: 実務手順
• references/Level3_advanced.md: 高度な設計
• references/Level4_expert.md: 複合フロー
• references/oauth2-flows.md: OAuthフロー詳細
• references/token-management.md: トークン管理
• references/security-best-practices.md: セキュリティ指針
• references/legacy-skill.md: 旧版要約（移行時のみ参照）

スクリプト

• scripts/generate-auth-flow-diagram.sh: 図生成補助
• scripts/test-auth-endpoint.sh: エンドポイント確認
• scripts/validate-skill.mjs: スキル構造検証
• scripts/log_usage.mjs: 実行ログ記録

テンプレート

• assets/auth-quickstart.md: クイックスタート
• assets/oauth2-diagrams.md: 図解テンプレ

変更履歴