Claude Codeのカスタムスラッシュコマンドでドキュメント作成を効率化する
はじめに
技術プロジェクトにおいて、ドキュメントの作成・更新・メンテナンスは重要な作業ですが、多くの開発者にとって煩雑で時間がかかる作業でもあります。特に、Sphinxのようなドキュメント生成ツールは高機能である反面、設定が複雑で学習コストが高いという課題があります。
本記事では、 Claude Codeのカスタムスラッシュコマンド機能 を活用して、こうした課題を解決し、効率的なドキュメント作成環境を構築する方法を紹介します。
Claude Codeのカスタムスラッシュコマンドとは
Claude Codeは、.claude/commands/ディレクトリに配置したMarkdownファイルを自動的に読み込み、カスタムスラッシュコマンドとして利用できる機能を提供しています。
主な利点
- プロジェクト固有の操作を標準化: 複雑なコマンドラインや設定手順を単一のコマンドに集約
- チーム全体での作業統一: 同じコマンドを使うことで、メンバー間の作業方法を統一
- 学習コストの削減: 複雑なツールの使い方を覚える必要がなく、シンプルなコマンドで操作可能
- 自動化の促進: 手動で行っていた複数ステップの作業を自動化
- コマンドのMarkdown化: スクリプトではなく自然言語で手順を記述することで、理解しやすく保守しやすい形式で管理
ファイル構成
このシステムは以下のファイル構成で構築されています：
.claude
├── commands # Claude Codeのカスタムスラッシュコマンド定義
│ ├── sphinx-build.md
│ ├── sphinx-create.md
│ └── sphinx-update.md
├── docs
│ ├── CLAUDE.md # システムのドキュメントとガイド
│ └── config # Sphinx設定ファイル（テーマと拡張機能）
│ ├── extensions-config.md
│ └── theme-settings.md
サンプル実装：Sphinxドキュメント自動化システム
本記事では、Claude Codeのカスタムスラッシュコマンド機能の具体的な活用例として、PythonのSphinxを使ったドキュメント自動化システムのサンプル実装を紹介します。
1. /sphinx-create - プロジェクト初期化
このコマンドは以下を自動実行します：
- 必要なPythonパッケージのインストール（Sphinx、MyST Parser等）
-
pyproject.tomlからプロジェクト情報を自動取得 - Sphinxプロジェクトの初期化
- ReStructuredTextからMarkdownへの変換（SphinxのデフォルトであるreStructuredTextから、より一般的で馴染みやすいMarkdown形式に変更）
- 基本的な拡張機能の有効化
2. /sphinx-update - 設定更新
このコマンドは以下を実行します：
-
.claude/docs/config/の設定ファイルから設定を読み込み -
docs/conf.pyを安全に更新 - 必要な追加パッケージを自動インストール
- 既存設定を保持しながら特定セクションのみを更新
3. /sphinx-build - ドキュメントビルド
このコマンドは以下を実行します：
- 依存関係の確認
- 指定形式でのドキュメントビルド（HTML、LaTeX、EPUB等）
- エラー時の詳細情報表示
使用方法
1. Claude Codeで設定を取り込み
自分のプロジェクトディレクトリで、Claude Codeを起動してメッセージを送信：
claude
Claude Codeが起動したら、以下のメッセージを送信：
https://github.com/drillan/claude-sphinx-toolkit の .claude ディレクトリを現在のプロジェクトにコピーしてください
Claude Codeが自動的にGitHubリポジトリから.claude/ディレクトリを取得して、現在のプロジェクトに設定します。
2. 手動でのセットアップ（オプション）
Claude Codeを使わない場合は、従来通りgit cloneでも可能です：
git clone https://github.com/drillan/claude-sphinx-toolkit.git
cp -r claude-sphinx-toolkit/.claude/ your-project/
cd your-project/
3. プロジェクト情報の設定
pyproject.tomlにプロジェクト情報を設定します：
[project]
name = "your-project-name"
authors = [
{name = "Your Name", email = "your.email@example.com"}
]
4. プロジェクトのCLAUDE.mdにルールを記述
プロジェクトルートのCLAUDE.mdファイルに、ドキュメント作成のルールを記述します：
# CLAUDE.md
## ドキュメント作成ルール
### 基本方針
- Sphinxドキュメントシステムを使用する
- 新しいドキュメントファイル作成後は必ず `/sphinx-update` を実行
- ビルド前に `/sphinx-build` でエラーがないか確認
### 依存関係管理
- ドキュメント関連パッケージは `uv add --group docs` で管理
- 設定変更後は必ず `uv sync --group docs` を実行
### 利用可能なコマンド
- `/sphinx-create` - 新規Sphinxプロジェクトの初期化
- `/sphinx-update` - 設定更新
- `/sphinx-build` - ドキュメントビルド
このルールにより、Claude Codeが常に適切な手順でドキュメント作業を行うようになります。
5. Claude Codeでコマンドを実行
Claude Codeを起動し、プロジェクトディレクトリで以下のコマンドを実行：
# 初期化
/sphinx-create
# 設定更新
/sphinx-update
# ビルド
/sphinx-build
他の言語・ツールへの応用
この手法は、Python/Sphinxに限らず、様々な言語やドキュメントツールに応用可能です：
応用例
- Node.js + JSDoc: JavaScript/TypeScriptプロジェクトのAPI文書生成
- Go + Hugo: Goプロジェクトの静的サイト生成
- Java + Maven Site: Javaプロジェクトのサイト生成
- Ruby + YARD: Rubyプロジェクトのドキュメント生成
- Rust + mdBook: RustプロジェクトのBook形式ドキュメント
応用のポイント
- コマンドの標準化: 言語に関係なく、
/doc-create、/doc-build等の統一命名 - 設定の外部化: プロジェクト固有の設定を
.claude/config/に分離 - 依存関係管理: 各言語のパッケージマネージャーに対応した自動インストール
関係者が得られる利益
開発者
- 時短効果: 複雑なコマンドを覚える必要がなく、作業時間を短縮
- 品質向上: 統一された手順により、ドキュメントの品質が安定
- ストレス軽減: 設定ミスやコマンド間違いによるエラーを削減
チームリーダー・プロジェクトマネージャー
- 品質管理: 全メンバーが同じ手順でドキュメントを作成するため、品質のバラツキを削減
- オンボーディング効率化: 新メンバーの学習コストを削減
- メンテナンス性向上: 標準化された手順により、長期的なメンテナンスが容易
組織・企業
- 知識の属人化防止: 標準化により、特定の人に依存しない体制を構築
- 生産性向上: ドキュメント作成の効率化により、開発リソースをより重要な作業に集中
- 品質保証: 一貫した品質のドキュメントにより、顧客満足度や開発効率が向上
まとめ
Claude Codeのカスタムスラッシュコマンド機能を活用することで、複雑なドキュメント作成プロセスを簡素化できます。本記事で紹介したSphinx自動化システムは、そのまま使用することも、他のツールに応用することも可能です。
プロジェクトの特性に合わせてカスタムコマンドを作成し、チーム全体の生産性向上とドキュメント品質の向上を実現してください。
詳細な設定ファイル
システムの詳細な設定は、以下のファイルで管理されています：
テーマ設定
Sphinxのテーマとテーマオプションを管理するファイルです。Furo、Sphinx RTD Theme、Sphinx Book Themeなどの設定が可能です。
拡張機能設定
Sphinxの拡張機能とその設定を管理するファイルです。MyST Parser、Autodoc、Napoleon、Intersphinxなどの設定が含まれています。
Pythonパッケージ管理ガイド
uvを使用したモダンなPythonパッケージ管理の包括的なガイドです。
ドキュメントシステム概要
アーキテクチャ、開発用コマンド、技術スタックの詳細説明です。
Discussion