ClaudeCodeLab
Tips & Tricks

Comment générer automatiquement la documentation avec Claude Code

Découvrez comment générer automatiquement la documentation avec Claude Code. Conseils pratiques et exemples de code inclus.

ドキュメント作成の負担をゼロにする

ドキュメントは重要だとわかっていても後回しにされがちです。Claude Codeを使えば、コードからドキュメントを自動生成し、常に最新の状態を維持できます。

JSDoc / TSDocの自動付与

> src/ 以下のすべてのpublic関数にJSDocコメントを追加して。
> パラメータ、戻り値、使用例を含めて。
/**
 * ユーザーを検索して結果を返す
 *
 * @param query - 検索クエリ文字列
 * @param options - 検索オプション
 * @param options.page - ページ番号（デフォルト: 1）
 * @param options.limit - 1ページあたりの件数（デフォルト: 20）
 * @param options.sortBy - ソートフィールド
 * @returns 検索結果とページネーション情報
 *
 * @example
 * ```typescript
 * const result = await searchUsers("田中", { page: 1, limit: 10 });
 * console.log(result.data); // User[]
 * console.log(result.meta.total); // 総件数
 * ```
 */
async function searchUsers(
  query: string,
  options: SearchOptions = {}
): Promise<PaginatedResult<User>> {
  // 実装
}

API仕様書の生成

コードからOpenAPI仕様書を自動生成させます。

> src/routes/ 以下のAPIエンドポイントを分析して、
> OpenAPI 3.0形式のAPI仕様書を生成して。
> リクエスト/レスポンスの型も含めて。
openapi: "3.0.3"
info:
  title: "Task Management API"
  version: "1.0.0"
  description: "タスク管理アプリケーションのAPI"

paths:
  /api/tasks:
    get:
      summary: "タスク一覧を取得"
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: status
          in: query
          schema:
            type: string
            enum: [todo, in_progress, done]
      responses:
        "200":
          description: "成功"
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Task"
                  meta:
                    $ref: "#/components/schemas/Pagination"

    post:
      summary: "タスクを作成"
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTaskInput"
      responses:
        "201":
          description: "作成成功"

READMEの生成

プロジェクトの構成から自動でREADMEを生成します。

> プロジェクトの構成を分析して、READMEを生成して。
> セットアップ手順、開発コマンド、ディレクトリ構成、
> 環境変数の説明を含めて。

アーキテクチャドキュメント

> プロジェクトのアーキテクチャを分析して、
> ディレクトリ構成とデータフローを説明する
> ドキュメントを作成して。
# アーキテクチャ概要

## ディレクトリ構成
src/
├── app/          # Next.js App Router ページ
├── components/   # UIコンポーネント
│   ├── ui/       # 汎用UIパーツ
│   └── features/ # 機能別コンポーネント
├── lib/          # ユーティリティ・設定
│   ├── db.ts     # データベース接続
│   ├── auth.ts   # 認証ロジック
│   └── api.ts    # APIクライアント
└── types/        # 型定義

## データフロー
1. クライアント → Server Component → Prisma → PostgreSQL
2. クライアント → API Route → Service Layer → Repository → DB

変更履歴の自動生成

> 直近のリリースからのgitログを分析して、
> CHANGELOGエントリを生成して。
> カテゴリ分け（Features, Bug Fixes, Breaking Changes）して。
## [1.3.0] - 2026-04-01

### Features
- ダッシュボードに売上グラフを追加 (#142)
- タスクの一括操作機能を実装 (#138)

### Bug Fixes
- フィルター条件がリセットされる問題を修正 (#145)
- 日付表示のタイムゾーン問題を修正 (#143)

### Breaking Changes
- APIレスポンスの形式を統一（v1 APIは非推奨に）

コードコメントの品質改善

> 既存のコメントを見直して、不正確なものを修正し、
> 複雑なロジックに説明を追加して。
> 自明なコメント（ i++ // increment i 等）はDeleteして。

Git操作の自動化と組み合わせれば、コミットメッセージからCHANGELOGの自動生成も可能です。詳しくはGit操作を完全自動化を参照してください。CLAUDE.mdにドキュメントルールを書いておくと一貫性が保たれます。書き方はCLAUDE.mdの書き方完全ガイドをご覧ください。

CLAUDE.mdにドキュメントルールを設定

## ドキュメントルール
- public関数には必ずJSDocを付与
- 新しいAPIエンドポイント追加時はOpenAPI仕様も更新
- 複雑なロジックにはインラインコメントを追加
- 自明なコメントは不要

Summary

Claude Codeでドキュメント生成を自動化すれば、コードとドキュメントの乖離を防げます。JSDoc、API仕様書、アーキテクチャドキュメントをコードから直接生成することで、常に正確な情報を維持しましょう。

ドキュメント生成の詳細はTypeDoc公式サイト、Claude CodeについてはAnthropic公式ドキュメントを参照してください。

#Claude Code #documentation #JSDoc #API specs #auto-generation

Related Posts