💻 Claude Code入門 📖 約20分で読めます

Claude Codeでドキュメントを自動生成する

README・API文書・コードコメントを効率的に作成

クロガイド｜Claude＆Claude Codeを無料で学ぼう

AI基礎からプロンプト術、Claude Codeの使い方まで。知識レッスンとクイズ式トレーニングで、AIスキルを段階的にアップ。ユーザー登録不要、すべて無料で今すぐ始められます。

はじめに ― ドキュメント作成をAIに任せる

ドキュメント作成は開発において最も後回しにされがちな作業です。しかし、ドキュメントが不足しているプロジェクトは保守性が低下し、新メンバーのオンボーディングにも時間がかかります。Claude Codeを使えば、コードベースを読み取って自動的に正確なドキュメントを生成できます。

Claude Codeによるドキュメント生成が優れている点

コードとの整合性: 実際のコードを読み取って生成するため、内容が正確
一貫したフォーマット: テンプレートを指定すれば統一されたスタイルで生成
多言語対応: 日本語・英語など、指定した言語で生成可能
更新の容易さ: コード変更時に「ドキュメントも更新して」と一言で対応

1. README.mdの生成

READMEはプロジェクトの「顔」です。Claude Codeにプロジェクト全体を読み取らせて、包括的なREADMEを生成しましょう。

README生成の指示

> このプロジェクトのREADME.mdを作成して。
> 以下のセクションを含めて：
> - プロジェクト概要（バッジ付き）
> - 主な機能（箇条書き）
> - 技術スタック
> - セットアップ手順（前提条件→インストール→起動）
> - 環境変数の一覧（.env.exampleから読み取って）
> - ディレクトリ構成（ツリー表示）
> - APIエンドポイント一覧（簡易版）
> - テストの実行方法
> - コントリビューション方法
> - ライセンス
> 日本語と英語の両方で書いて。

Claude Codeが生成するREADMEの一部

# TaskFlow 📋

![Version](https://img.shields.io/badge/version-1.0.0-blue)
![License](https://img.shields.io/badge/license-MIT-green)

中小企業向けのタスク管理SaaSアプリケーション

## 主な機能

- ✅ カンバンボード＆ガントチャート表示
- 👥 チーム・プロジェクト管理
- 🔔 Slack / Teams連携通知
- 📊 進捗レポート自動生成

## セットアップ

### 前提条件
- Node.js 18以上
- PostgreSQL 16
- pnpm 8以上

### インストール
```bash
git clone https://github.com/example/taskflow.git
cd taskflow
pnpm install
cp .env.example .env  # 環境変数を設定
pnpm db:migrate
pnpm dev
```

README生成のコツ

観点	指示のポイント	効果
対象読者	「初めてプロジェクトを見る開発者向け」	前提知識の説明レベルが適切になる
セットアップ	「コピペで動くコマンドにして」	実行可能なコードブロックが生成される
環境変数	「.env.exampleから読み取って一覧化」	実際の設定に即した説明になる
バッジ	「shields.ioのバッジを追加して」	プロフェッショナルな見た目になる

2. API文書の生成

REST APIやGraphQL APIのドキュメントを、実際のルート定義やコントローラーのコードから自動生成します。

API文書生成の指示

> api/routes/ 配下のすべてのAPIエンドポイントの
> ドキュメントを作成して。各エンドポイントについて：
> - HTTPメソッドとパス
> - 説明
> - リクエストパラメータ（パス・クエリ・ボディ）
> - レスポンス形式（成功時・エラー時）
> - 認証要否
> - リクエスト/レスポンスのJSON例
> OpenAPI (Swagger) 3.0形式のYAMLで出力して。

生成されるOpenAPI仕様の一部

openapi: '3.0.3'
info:
  title: TaskFlow API
  version: '1.0.0'
paths:
  /api/tasks:
    get:
      summary: タスク一覧の取得
      security:
        - bearerAuth: []
      parameters:
        - name: status
          in: query
          schema:
            type: string
            enum: [todo, in_progress, done]
      responses:
        '200':
          description: タスク一覧
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'

3. JSDoc / docstring / PHPDocの生成

コード内のドキュメントコメントを一括生成します。既存コードを分析して、関数の目的・引数・戻り値を記述します。

JavaScript / TypeScript（JSDoc）

JSDoc生成の指示

> src/services/ 配下の全ファイルに対してJSDocコメントを追加して。
> - すべてのexportされた関数・クラス・型に対して
> - @param, @returns, @throws, @example を含める
> - 日本語で記述
> - 既存のコメントがある場合は上書きしないで

Before（コメントなし）

export async function findUserByEmail(email: string): Promise<User | null> {
  const user = await prisma.user.findUnique({ where: { email } });
  if (!user) return null;
  return sanitizeUser(user);
}

After（JSDoc付き）

/**
 * メールアドレスからユーザーを検索する
 *
 * @param email - 検索対象のメールアドレス
 * @returns ユーザーオブジェクト（見つからない場合はnull）
 * @throws {PrismaClientKnownRequestError} DB接続エラー時
 * @example
 * const user = await findUserByEmail('test@example.com');
 * if (user) {
 *   console.log(user.name);
 * }
 */
export async function findUserByEmail(email: string): Promise<User | null> {
  const user = await prisma.user.findUnique({ where: { email } });
  if (!user) return null;
  return sanitizeUser(user);
}

Python（docstring）

docstring生成の指示

> app/services/ 配下の全Pythonファイルにdocstringを追加して。
> - Google styleのdocstring形式
> - Args, Returns, Raises を含める
> - 日本語で記述
> - 型情報はtype hintsと重複しないようにする

PHP（PHPDoc）

PHPDoc生成の指示

> app/ 配下のPHPファイルにPHPDocコメントを追加して。
> - クラスとすべてのpublic/protectedメソッドに対して
> - @param, @return, @throws を含める
> - @author と @since も付けて

4. アーキテクチャドキュメントの生成

プロジェクトの全体構造を説明するアーキテクチャドキュメントは、新メンバーのオンボーディングに欠かせません。

アーキテクチャ文書の生成指示

> このプロジェクトのアーキテクチャドキュメントを
> docs/ARCHITECTURE.md として作成して。
> 含める内容：
> - システム全体のアーキテクチャ図（Mermaid記法）
> - レイヤー構成（プレゼンテーション→サービス→データ）
> - 主要コンポーネントの責任と依存関係
> - データフロー（リクエストからレスポンスまで）
> - 使用しているデザインパターン
> - ディレクトリ構成の設計意図

生成されるMermaid図の例

```mermaid
graph TD
    Client[ブラウザ/モバイル] --> LB[ロードバランサー]
    LB --> API[API Server]
    API --> Auth[認証サービス]
    API --> TaskSvc[タスクサービス]
    API --> NotifSvc[通知サービス]
    TaskSvc --> DB[(PostgreSQL)]
    NotifSvc --> Queue[メッセージキュー]
    Queue --> Slack[Slack API]
    Queue --> Email[メールサービス]
```

5. セットアップガイド・CONTRIBUTING.mdの生成

新しい開発者がプロジェクトに参加する際のガイドドキュメントを生成します。

CONTRIBUTING.md生成の指示

> CONTRIBUTING.md を作成して。以下を含めて：
> - 開発環境のセットアップ手順（OS別）
> - ブランチ命名規則（feature/xxx, fix/xxx）
> - コミットメッセージ規約（Conventional Commits）
> - プルリクエストのテンプレート
> - コードレビューのチェックリスト
> - テストの書き方と実行方法
> - コーディング規約の概要
> プロジェクトの package.json と既存の設定を読み取って
> 実際の内容に即した形で書いて。

6. インラインコメントの追加

複雑なロジックに対して、コードを読む人の理解を助けるインラインコメントを追加します。

インラインコメント追加の指示

> src/utils/encryption.ts にインラインコメントを追加して。
> 以下のルールで：
> - 「何をしているか」ではなく「なぜそうしているか」を書く
> - 自明なコードにはコメントを付けない
> - 複雑なアルゴリズムには処理の流れを説明
> - マジックナンバーには意味を注釈
> - TODO/FIXME/HACKは理由と一緒に記述

良いコメントと悪いコメントの例

// ❌ 悪いコメント: 何をしているか（コードを読めばわかる）
// iを1増やす
i++;

// ✅ 良いコメント: なぜそうしているか
// APIのレート制限（100req/min）を超えないよう、
// リクエスト間に600msの待機を入れる
await sleep(600);

// ✅ 良いコメント: マジックナンバーの説明
// JWTの有効期限: 7日間（秒換算）
const TOKEN_EXPIRY = 604800;

ドキュメントの更新・保守

ドキュメントは一度作って終わりではなく、コードの変更に合わせて更新する必要があります。Claude Codeを使えば、この保守作業も効率化できます。

ドキュメント保守のワークフロー

変更検知: 「最近変更したファイルを確認して、関連するドキュメントを特定して」
差分確認: 「ドキュメントの記述と実際のコードに差異がないか確認して」
更新: 「差異がある箇所のドキュメントを最新のコードに合わせて更新して」
レビュー: 「更新した箇所の一覧を表示して」

ドキュメント更新の会話例

> 先週のコミットで変更されたファイルの中で、
> ドキュメントの更新が必要なものがないかチェックして。
> APIのエンドポイントが変わっていたり、
> 新しい環境変数が追加されていたりしないか確認。

Claude Code:
git log --since="1 week ago" を確認します...

以下のドキュメント更新が必要です：

1. README.md - 新しい環境変数 REDIS_URL が追加されています
2. docs/API.md - /api/tasks に PATCH メソッドが追加されています
3. .env.example - REDIS_URL の記載がありません

更新しましょうか？