swagger-docs
Swagger/OpenAPIドキュメントの作成・更新、新しいエンドポイントの文書化、既存のAPIドキュメントの完全性確認、またはコードからのOpenAPI仕様生成を行う場合に使用します。内部専用APIで外部利用者がおらず、ドキュメント要件がない場合はスキップしてください。エンドポイント命名、HTTP規約、バージョニング戦略などのAPI設計判断を行う場合はスキップし、代わりにapi-designを使用してください。
description の原文を見る
Use when writing or updating Swagger/OpenAPI docs, documenting new endpoints, reviewing existing API docs for completeness, or generating OpenAPI spec from code. Skip when the API is internal-only with no external consumers and no doc requirement. Skip when making API design decisions (endpoint naming, HTTP conventions, versioning strategy) — use api-design instead.
SKILL.md 本文
OpenAPI 3.0 ドキュメンテーション
チーム標準: OpenAPI Specification 3.0.x OAS 3.1 および 3.2 はより新しいバージョンで、JSON Schema との完全な対応があります。ツールのサポートが成熟した時点で移行してください。 以下のルールは仕様(OAS 3.0.x で必須 — 違反するとツールが動作しない)または慣例(OpenAPI Initiative の業界ベストプラクティス — 違反は開発者体験を損なう)のいずれかです。
コア原則
ドキュメンテーションが完全な状態とは、コードベースを見たことのない開発者が以下のことができる状態です:
summaryとdescriptionだけで各エンドポイントが何をするのかを理解できる- リクエストスキーマとサンプルから何を送信すべきかが正確にわかる
- 実装者に聞かなくても、エラーを含むすべての可能なレスポンスがわかる
ネーミングルール (慣例)
| 要素 | 慣例 | ルール |
|---|---|---|
operationId | camelCase 動詞+名詞 | スペッ |
...
詳細情報
- 作者
- phananhtuan09
- ライセンス
- unknown
- 最終更新
- 2026/5/7
Source: https://github.com/phananhtuan09/ai-agent-workflow / ライセンス: unknown
関連スキル
nature-response
Nature系ジャーナルの原稿修正に対する査読者への回答文について、下書き、チェック、または修正を行うことができます。査読者からのコメント、編集者の決定文、修正指示、回答案の作成、または大幅修正・軽微修正の対応方法に関するご相談があれば、対応いたします。査読報告書や回答文作成のサポートが必要な場合にご利用ください。
microsoft-docs
公式のMicrosoft文書を参照して、Azure、.NET、Agent Framework、Aspire、VS Code、GitHubなど様々な分野の概念、チュートリアル、コード例を検索します。デフォルトではMicrosoft Learn MCPを使用し、learn.microsoft.com外のコンテンツについてはContext7およびAspire MCPを使用します。
API Documentation Lookup
このスキルは、ユーザーが「Effect APIを調べる」「Effectドキュメントを確認する」「Effect関数のシグネチャを探す」「Effect.Xは何をするのか」「Effect.Xの使い方」「Effect APIリファレンス」「Effectドキュメントを取得する」といった質問をした場合や、公式のEffect-TS APIドキュメントから特定の関数シグネチャ、パラメータ、使用例を調べる必要がある場合に使用します。
knowledge-base
このスキルは、ヘルプセンターのアーキテクチャ設計、サポート記事の執筆、検索とセルフサービスの最適化が必要な場合に活用できます。ナレッジベース、ヘルプセンター、サポート記事、セルフサービス、記事テンプレート、検索最適化、コンテンツ分類、ヘルプドキュメントの設計・管理に関するあらゆるタスクで動作します。
markdown
GitHub Flavored Markdown標準に従ったMarkdownファイルのフォーマットと検証ができます。自動的なlinting処理と手動による意味的なレビューを組み合わせることで、ファイルの品質を確保します。
claude-md-enhancer
CLAUDE.mdファイルをプロジェクトタイプに合わせて分析・生成・改善します。ベストプラクティス、モジュール設計対応、技術スタックのカスタマイズに対応しています。新規プロジェクトの立ち上げ、既存のCLAUDE.mdファイルの改善、またはAI支援開発の標準化を図る際にご活用ください。