How to Auto-Generate Documentation: Claude Code 활용 가이드

문서생성の負担をゼロにする

문서は重要だとわかっていても後回しにされがちです。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仕様も更新
- 複雑なロジックにはインラインコメントを追加
- 自明なコメントは不要

정리

Claude Code로문서생성を자동화すれば、コードと문서の乖離を防げます。JSDoc、API仕様書、아키텍처문서をコードから直接생성することで、常に正確な情報を維持합시다。

문서생성의 상세 정보는TypeDoc공식 사이트、Claude Code에ついてはAnthropic공식 문서를 참고하세요.