docusaurus-config-setup について
Docusaurus の設定構築に特化した、技術ドキュメント向けのスキルです。段階的な案内や設定・コードの生成を行い、一般的な基準に照らして出力を検証します。
主な機能
- 01段階的な設定ガイダンス
- 02設定とコードの生成
- 03ベストプラクティスの提案
- 04出力の検証
活用シーン
- 01Docusaurus 設定の構築
- 02ドキュメント関連設定の生成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/docusaurus-config-setupを入力して読み込まれたか確認します。
詳細
Docusaurus 設定のセットアップ
概要
このスキルは、技術ドキュメント分野における Docusaurus 設定のセットアップ作業を自動的に支援します。
使用するタイミング
次の場合に、このスキルが自動的に有効になります。
- リクエストで「docusaurus config setup」に言及した場合
- Docusaurus 設定のセットアップパターンやベストプラクティスについて質問した場合
- API ドキュメント、ユーザーガイド、アーキテクチャドキュメント、ドキュメントの自動化を扱う技術ドキュメントスキルの支援が必要な場合
手順
- Docusaurus 設定のセットアップについて、手順に沿ってガイダンスを提供します
- 業界のベストプラクティスとパターンに従います
- 本番環境で使用できるコードと設定を生成します
- 一般的な標準に照らして出力を検証します
例
例：基本的な使い方 リクエスト：「Docusaurus 設定のセットアップを手伝ってください」 結果：手順に沿ったガイダンスを提供し、適切な設定を生成します
前提条件
- 関連する開発環境が構成されていること
- 必要なツールとサービスを利用できること
- 技術ドキュメントの概念を基本的に理解していること
出力
- 生成された設定とコード
- ベストプラクティスの推奨事項
- 検証結果
エラー処理
| エラー | 原因 | 解決策 |
|---|---|---|
| 設定が無効です | 必須フィールドがありません | 必須パラメーターについてドキュメントを確認してください |
| ツールが見つかりません | 依存関係がインストールされていません | 前提条件に従って必要なツールをインストールしてください |
| アクセスが拒否されました | アクセス権限が不十分です | 認証情報と権限を確認してください |
リソース
- 関連ツールの公式ドキュメント
- ベストプラクティスガイド
- コミュニティの事例とチュートリアル
関連スキル
技術ドキュメントスキルカテゴリの一部です。 タグ：ドキュメント、Markdown、API ドキュメント、README、テクニカルライティング
コメント
Markdown 対応