Cara Auto-Generate Dokumentasi dengan Claude Code

Hilangkan Beban Pembuatan Dokumentasi

Meskipun tahu dokumentasi itu penting, sering kali ditunda. Dengan Claude Code, kamu bisa auto-generate dokumentasi dari kode dan menjaganya selalu up-to-date.

Penambahan Otomatis JSDoc / TSDoc

> Tambahkan komentar JSDoc ke semua fungsi public di bawah src/.
> Sertakan parameter, return value, dan contoh penggunaan.

/**
 * Mencari pengguna dan mengembalikan hasilnya
 *
 * @param query - String query pencarian
 * @param options - Opsi pencarian
 * @param options.page - Nomor halaman (default: 1)
 * @param options.limit - Jumlah per halaman (default: 20)
 * @param options.sortBy - Field untuk sorting
 * @returns Hasil pencarian dan informasi pagination
 *
 * @example
 * ```typescript
 * const result = await searchUsers("Tanaka", { page: 1, limit: 10 });
 * console.log(result.data); // User[]
 * console.log(result.meta.total); // Total keseluruhan
 * ```
 */
async function searchUsers(
  query: string,
  options: SearchOptions = {}
): Promise<PaginatedResult<User>> {
  // Implementasi
}

Generate Spesifikasi API

Auto-generate spesifikasi OpenAPI dari kode.

> Analisis API endpoint di bawah src/routes/,
> lalu generate spesifikasi API format OpenAPI 3.0.
> Sertakan juga tipe request/response.

openapi: "3.0.3"
info:
  title: "Task Management API"
  version: "1.0.0"
  description: "API untuk aplikasi manajemen task"

paths:
  /api/tasks:
    get:
      summary: "Mengambil daftar task"
      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: "Berhasil"
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Task"
                  meta:
                    $ref: "#/components/schemas/Pagination"

    post:
      summary: "Membuat task"
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTaskInput"
      responses:
        "201":
          description: "Berhasil dibuat"

Generate README

Auto-generate README dari struktur proyek.

> Analisis struktur proyek dan generate README.
> Sertakan langkah setup, command development, struktur direktori,
> dan penjelasan environment variable.

Dokumen Arsitektur

> Analisis arsitektur proyek,
> buat dokumen yang menjelaskan struktur direktori
> dan alur data.

# Gambaran Arsitektur

## Struktur Direktori
src/
├── app/          # Halaman Next.js App Router
├── components/   # Komponen UI
│   ├── ui/       # Part UI umum
│   └── features/ # Komponen per fitur
├── lib/          # Utilitas & konfigurasi
│   ├── db.ts     # Koneksi database
│   ├── auth.ts   # Logika autentikasi
│   └── api.ts    # API client
└── types/        # Definisi tipe

## Alur Data
1. Client -> Server Component -> Prisma -> PostgreSQL
2. Client -> API Route -> Service Layer -> Repository -> DB

Auto-Generate Changelog

> Analisis git log sejak rilis terakhir,
> generate entri CHANGELOG.
> Kategorikan (Features, Bug Fixes, Breaking Changes).

## [1.3.0] - 2026-04-01

### Features
- Tambah grafik penjualan di dashboard (#142)
- Implementasi fitur operasi task secara massal (#138)

### Bug Fixes
- Perbaiki masalah kondisi filter yang ter-reset (#145)
- Perbaiki masalah timezone pada tampilan tanggal (#143)

### Breaking Changes
- Standardisasi format respons API (API v1 di-deprecate)

Peningkatan Kualitas Komentar Kode

> Review komentar yang ada, perbaiki yang tidak akurat,
> dan tambahkan penjelasan untuk logika yang kompleks.
> Hapus komentar yang sudah jelas (seperti i++ // increment i).

Jika digabungkan dengan otomatisasi operasi Git, auto-generate CHANGELOG dari commit message juga dimungkinkan. Untuk detail, lihat Otomatisasi Penuh Operasi Git. Menulis aturan dokumentasi di CLAUDE.md akan menjaga konsistensi. Untuk cara penulisannya, lihat Panduan Lengkap Menulis CLAUDE.md.

Pengaturan Aturan Dokumentasi di CLAUDE.md

## Aturan Dokumentasi
- Fungsi public wajib memiliki JSDoc
- Saat menambahkan API endpoint baru, perbarui juga spesifikasi OpenAPI
- Tambahkan komentar inline untuk logika yang kompleks
- Komentar yang sudah jelas tidak diperlukan

Summary

Dengan mengotomatisasi generate dokumentasi menggunakan Claude Code, kamu bisa mencegah perbedaan antara kode dan dokumentasi. Dengan men-generate JSDoc, spesifikasi API, dan dokumen arsitektur langsung dari kode, informasi yang akurat selalu bisa dijaga.

Untuk detail generate dokumentasi, lihat Situs Resmi TypeDoc, dan untuk Claude Code, lihat Dokumentasi Resmi Anthropic.