documentation-builder

このスキルを使う場面

ユーザーが次のことを希望する場合は、いつでもこのスキルを使ってください。

• インストール、使い方、コントリビューションのセクションを含むプロジェクトの README を生成する
• コードまたは OpenAPI 仕様から API ドキュメントを作成する
• 開発者向けのオンボーディングガイドやセットアップガイドを作成する
• ユーザーマニュアルやクイックスタートチュートリアルを作成する
• 新規または既存のプロジェクト向けにドキュメントを構成する
• コミット履歴やリリースノートから CHANGELOG を生成する

このスキルの使い方

ワークフロー

1. ドキュメントの種類を特定する - README、API リファレンス、ユーザーガイド、開発者ガイド、変更履歴のいずれか
2. コンテキストを収集する - コードベース、既存のドキュメント、プロジェクト構成を確認する
3. ドキュメントを生成する - 以下のテンプレートとパターンを使う
4. 検証する - すべてのコード例が実行でき、リンクが有効で、セクションが揃っていることを確認する

README テンプレート

# Project Name

Brief description of what the project does and why it exists.

## Quick Start

\`\`\`bash
npm install my-package
\`\`\`

\`\`\`typescript
import { MyClient } from 'my-package';
const client = new MyClient({ apiKey: process.env.API_KEY });
const result = await client.query('hello');
\`\`\`

## Features

- Feature one with brief explanation
- Feature two with brief explanation

## Installation

Detailed installation steps for different environments.

## Usage

Detailed usage examples with code snippets.

## API Reference

Link to full API docs or inline reference.

## Contributing

How to contribute, run tests, and submit PRs.

## License

License type and link.

API ドキュメントのパターン（OpenAPI）

paths:
  /users/{id}:
    get:
      summary: Get user by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found

ベストプラクティス

1. クイックスタートから始める - 読者が 2 分以内に使い始められるようにする
2. 実行可能なコード例を含める - すべての API エンドポイントや関数に、コピーして貼り付けられる例を用意する
3. ドキュメントをコードの近くに置く - 説明対象のソースとドキュメントを同じ場所に配置する
4. 一貫した構成にする - すべてのドキュメントページで同じ見出し階層に従う
5. ドキュメントをバージョン管理する - コードのリリースに合わせてドキュメントにもタグを付ける

キーワード

ドキュメント作成, documentation, README, API ドキュメント, OpenAPI, Swagger, ユーザーガイド, ユーザーマニュアル, 開発者ガイド, 開発ガイド, changelog, 技術ドキュメント