“` html
Docsスキル:ガイドおよびAPIリファレンスに関する概要
本ドキュメントは、「Docsスキル」として、APIリファレンス作成を支援するための**執筆スキル**と**一貫したフォーマット**に関するガイドをまとめたものです。これは、[Next.jsのプルリクエスト #90992](https://www.google.com/search?q=https://github.com/vercel/next.js/pull/90992)に関連する内容です。
Docs執筆を支援する2つの主要スキル
Docs執筆プロセスにおいて、具体的に以下の2つのスキルが提供されます。
write-guide (ガイド作成スキル)
- 目的: 段階的な開示と、「導入、概要、ステップバイステップの手順、次のステップ」という一貫したフォーマットに基づいたガイド作成を支援します。
- 効果的な活用法: エージェントにデモンストレーション(デモ)を与えることで、最も効果的に機能します。
write-api-reference (APIリファレンス作成スキル)
- 目的: APIの種類(コンポーネント、関数、ファイルなど)を分析し、一貫したフォーマットに従ってリファレンスのドラフト作成を支援します。
- コンテキストの利用: ソースコード、PRの説明、RFC(設計提案)などのコンテキストを与えることで、最も効果的に機能します。また、リポジトリのe2eテストといったコンテキストも探索します。
運用上の重要な留意事項
- 初期ドラフトの位置づけ: スキルは最初のドラフト(約80%の完成度)を作成するために役立ちます。人間による**正確性のチェック**と**APIのテスト**を実施し、最終的に110%の品質に仕上げることが求められます。
- 過去の作業の参照: 技術的な執筆に関する明確なガイダンスが不足している場合、過去の作業を参照として与えることで、スキルは最も効果的に機能いたします。
関連クローズ済みイシュー
共同著者: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
“`
