docs-page-generator
ユーザーがドキュメンテーションサイトを作成、最適化、または構築したい場合に使用します。「docs」「ドキュメンテーションサイト」「docsサブドメイン」「docs.yourdomain.com」「ヘルプセンター」「ナレッジベース」「Getting Started」「APIリファレンス」「ユーザーガイド」「チュートリアル」などの言及がある場合にも対応します。
description の原文を見る
When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "docs.yourdomain.com," "help center," "knowledge base," "Getting Started," "API Reference," "user guides," or "tutorials."
SKILL.md 本文
Pages: Documentation Site
ドキュメンテーションサイトの構造、ナビゲーション、コンテンツ組織をガイドします。通常、docs.* または help.* サブドメインでホストされます。Getting Started、ガイド、チュートリアル、API Reference(エンドポイントドキュメント)、トラブルシューティングが含まれます。API 紹介ページ(api-page-generator)とは別のものです。
呼び出し時: 初回使用時の場合、必要に応じて、このスキルが何をカバーしているか、なぜそれが重要かについて 1~2 文で説明してから、メイン出力を提供してください。後続の使用時またはユーザーがスキップを求めた場合は、メイン出力に直接移動してください。
初期評価
まずプロダクトマーケティングコンテキストを確認してください: .claude/product-marketing-context.md または .cursor/product-marketing-context.md が存在する場合は、それを読んでプロダクト、対象ユーザー、ユースケースについて確認してください。
以下を識別します:
- プロダクトタイプ: ソフトウェア、API、ハードウェア、サービス
- 対象ユーザー: エンドユーザー、開発者、管理者
- コンテンツソース: Markdown、MDX、Git、CMS
- サブドメイン: docs.、help.、またはパス(/docs)
Documentation Structure
| セクション | 目的 | 典型的なコンテンツ |
|---|---|---|
| Getting Started | オンボーディング、最初のステップ | クイックスタート、インストール、最初のタスク |
| Guides / Tutorials | ステップバイステップの学習 | ハウツー記事、ワークフロー |
| Concepts | 背景知識、アーキテクチャ | 主要概念、用語集リンク |
| API Reference | エンドポイントドキュメント | 認証、リクエスト/レスポンス、例;ドキュメント内の一部であり、独立したページではない |
| Troubleshooting | 問題解決 | FAQ、一般的なエラー、サポートリンク |
ベストプラクティス
情報アーキテクチャ
- 段階的な情報開示: シンプルから始めて、詳細へのリンクを提供
- サイドバーナビゲーション: 階層的で折り畳み可能なセクション
- 検索: ドキュメント量が多い場合、全文検索機能
- パンくずリスト: 深い階層構造の場合
API Reference(ドキュメント内)
API Reference はドキュメントのセクションであり、スタンドアロンのページではありません。リソース別のエンドポイント、認証、リクエスト/レスポンススキーマ、エラーコード、レート制限、コード例(cURL、SDK)を含めてください。一貫性のため OpenAPI/Swagger を使用します。
コンテンツ
- タスク指向: 「X 機能」ではなく「X する方法」
- コード例: コピー&ペーストできる状態で、関連する場合は複数の言語対応
- スクリーンショット/動画: UI が多いプロダクト向け
- バージョニング: 該当する場合、プロダクト/API バージョンを記載
SEO と発見性
- ドキュメントのインデックス: 内部専用でない限り;必要に応じてロボッツ設定を使用
- 内部リンク: 関連記事へのクロスリンク、メインサイトへのリンク
- スキーマ: ガイド用に TechArticle、HowTo を使用
出力フォーマット
- 構造(セクション、階層)
- ナビゲーションデザイン(サイドバー、トップレベル)
- Getting Started アウトライン
- コンテンツチェックリスト(セクション別)
- サブドメイン/パス推奨事項
関連スキル
- api-page-generator: API 紹介ページからドキュメントへのリンク
- sidebar-generator: ドキュメントサイドバー設計
- faq-page-generator: FAQ はドキュメント内またはメインサイト内に存在可能
- content-strategy: ドキュメントコンテンツ計画
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- irismaker
- ライセンス
- MIT
- 最終更新
- 2026/4/30
Source: https://github.com/irismaker/ai-agent-skills-hub / ライセンス: MIT