✍️ ライティングコミュニティ

documentation-writer

READMEやAPIドキュメント、コード注釈、設計書など、ソフトウェア開発に必要な様々なドキュメントを、網羅的かつ分かりやすく作成するSkill。

📜 元の英語説明(参考)

生成全面的文档，包括README文件、API文档、代码注释（JSDoc、docstrings、XML）和架构文档。

🇯🇵 日本人クリエイター向け解説

一言でいうと

READMEやAPIドキュメント、コード注釈、設計書など、ソフトウェア開発に必要な様々なドキュメントを、網羅的かつ分かりやすく作成するSkill。

※ jpskill.com 編集部が日本のビジネス現場向けに補足した解説です。Skill本体の挙動とは独立した参考情報です。

⚡ おすすめ: コマンド1行でインストール(60秒)

下記のコマンドをコピーしてターミナル(Mac/Linux)または PowerShell(Windows)に貼り付けてください。ダウンロード → 解凍 → 配置まで全自動。

🍎 Mac / 🐧 Linux

mkdir -p ~/.claude/skills && cd ~/.claude/skills && curl -L -o documentation-writer.zip https://jpskill.com/download/16474.zip && unzip -o documentation-writer.zip && rm documentation-writer.zip

🪟 Windows (PowerShell)

$d = "$env:USERPROFILE\.claude\skills"; ni -Force -ItemType Directory $d | Out-Null; iwr https://jpskill.com/download/16474.zip -OutFile "$d\documentation-writer.zip"; Expand-Archive "$d\documentation-writer.zip" -DestinationPath $d -Force; ri "$d\documentation-writer.zip"

完了後、Claude Code を再起動 → 普通に「動画プロンプト作って」のように話しかけるだけで自動発動します。

💾 手動でダウンロードしたい(コマンドが難しい人向け)

1. 下の青いボタンを押して documentation-writer.zip をダウンロード
2. ZIPファイルをダブルクリックで解凍 → documentation-writer フォルダができる
3. そのフォルダを C:\Users\あなたの名前\.claude\skills\(Win)または ~/.claude/skills/(Mac)へ移動
4. Claude Code を再起動

⬇ .zip でダウンロード(推奨) ⬇ .skill 形式(上級者用) 元のソース ↗

⚠️ ダウンロード・利用は自己責任でお願いします。当サイトは内容・動作・安全性について責任を負いません。

🎯 このSkillでできること

下記の説明文を読むと、このSkillがあなたに何をしてくれるかが分かります。Claudeにこの分野の依頼をすると、自動で発動します。

📦 インストール方法 (3ステップ)

1. 上の「ダウンロード」ボタンを押して .skill ファイルを取得
2. ファイル名の拡張子を .skill から .zip に変えて展開(macは自動展開可)
3. 展開してできたフォルダを、ホームフォルダの .claude/skills/ に置く
- · macOS / Linux: ~/.claude/skills/
- · Windows: %USERPROFILE%\.claude\skills\

Claude Code を再起動すれば完了。「このSkillを使って…」と話しかけなくても、関連する依頼で自動的に呼び出されます。

詳しい使い方ガイドを見る →

最終更新: 2026-05-18
取得日時: 2026-05-18
同梱ファイル: 1

📖 Skill本文(日本語訳)

※ 原文(英語/中国語)を Gemini で日本語化したものです。Claude 自身は原文を読みます。誤訳がある場合は原文をご確認ください。

Documentation Writer Skill

説明

コード、API、プロジェクトのための包括的なドキュメントを生成します。

トリガー

/docs コマンド
ユーザーがドキュメントを要求した場合
ユーザーが README や API ドキュメントを必要とする場合

プロンプト

あなたは、明確で包括的なドキュメントを作成するテクニカルライターです。

README テンプレート

# Project Name

このプロジェクトが何をするかの簡単な説明。

## 特徴

- ✅ Feature 1
- ✅ Feature 2
- 🚧 Feature 3 (進行中)

## クイックスタート

\`\`\`bash
# リポジトリをクローン
git clone https://github.com/user/project.git
cd project

# 依存関係をインストール
npm install

# 開発サーバーを起動
npm run dev
\`\`\`

## インストール

### 前提条件

- Node.js >= 18
- PostgreSQL >= 14

### 環境変数

\`\`\`env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
JWT_SECRET=your-secret-key
\`\`\`

## 使い方

\`\`\`typescript
import { Client } from 'my-library';

const client = new Client({ apiKey: 'xxx' });
const result = await client.doSomething();
\`\`\`

## API リファレンス

### `client.createUser(data)`

新しいユーザーを作成します。

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| email | string | Yes | ユーザーのメールアドレス |
| name | string | Yes | ユーザーの名前 |

**戻り値:** `Promise<User>`

## 貢献

1. リポジトリをフォーク
2. あなたのフィーチャーブランチを作成 (`git checkout -b feature/amazing`)
3. 変更をコミット (`git commit -m 'feat: add amazing feature'`)
4. ブランチにプッシュ (`git push origin feature/amazing`)
5. プルリクエストを開く

## ライセンス

MIT © [Your Name]

JSDoc コメント

/**
 * システムに新しいユーザーを作成します。
 * 
 * @param {CreateUserDto} data - ユーザー作成データ
 * @param {string} data.email - ユーザーのメールアドレス (一意である必要があります)
 * @param {string} data.name - ユーザーの表示名
 * @param {string} [data.avatar] - オプションのアバター URL
 * @returns {Promise<User>} 作成されたユーザーオブジェクト
 * @throws {ValidationError} メール形式が無効な場合
 * @throws {DuplicateError} メールアドレスが既に存在する場合
 * 
 * @example
 * const user = await userService.createUser({
 *   email: 'john@example.com',
 *   name: 'John Doe'
 * });
 */
async createUser(data: CreateUserDto): Promise<User> {
  // 実装
}

C# XML ドキュメント

/// <summary>
/// システムに新しいユーザーを作成します。
/// </summary>
/// <param name="data">ユーザー作成データ。</param>
/// <returns>作成されたユーザーオブジェクト。</returns>
/// <exception cref="ValidationException">メール形式が無効な場合にスローされます。</exception>
/// <exception cref="DuplicateException">メールアドレスが既に存在する場合にスローされます。</exception>
/// <example>
/// <code>
/// var user = await userService.CreateUserAsync(new CreateUserDto
/// {
///     Email = "john@example.com",
///     Name = "John Doe"
/// });
/// </code>
/// </example>
public async Task<User> CreateUserAsync(CreateUserDto data)
{
    // 実装
}

互換性

Codex: ✅
Claude Code: ✅

📜 原文 SKILL.md(Claudeが読む英語/中国語)を展開

Documentation Writer Skill

Description

Generate comprehensive documentation for code, APIs, and projects.

Trigger

/docs command
User requests documentation
User needs README or API docs

Prompt

You are a technical writer that creates clear, comprehensive documentation.

README Template

# Project Name

Brief description of what this project does.

## Features

- ✅ Feature 1
- ✅ Feature 2
- 🚧 Feature 3 (in progress)

## Quick Start

\`\`\`bash
# Clone the repository
git clone https://github.com/user/project.git
cd project

# Install dependencies
npm install

# Start development server
npm run dev
\`\`\`

## Installation

### Prerequisites

- Node.js >= 18
- PostgreSQL >= 14

### Environment Variables

\`\`\`env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
JWT_SECRET=your-secret-key
\`\`\`

## Usage

\`\`\`typescript
import { Client } from 'my-library';

const client = new Client({ apiKey: 'xxx' });
const result = await client.doSomething();
\`\`\`

## API Reference

### `client.createUser(data)`

Creates a new user.

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| email | string | Yes | User's email |
| name | string | Yes | User's name |

**Returns:** `Promise<User>`

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing`)
5. Open a Pull Request

## License

MIT © [Your Name]

JSDoc Comments

/**
 * Creates a new user in the system.
 * 
 * @param {CreateUserDto} data - The user creation data
 * @param {string} data.email - User's email address (must be unique)
 * @param {string} data.name - User's display name
 * @param {string} [data.avatar] - Optional avatar URL
 * @returns {Promise<User>} The created user object
 * @throws {ValidationError} If email format is invalid
 * @throws {DuplicateError} If email already exists
 * 
 * @example
 * const user = await userService.createUser({
 *   email: 'john@example.com',
 *   name: 'John Doe'
 * });
 */
async createUser(data: CreateUserDto): Promise<User> {
  // implementation
}

C# XML Documentation

/// <summary>
/// Creates a new user in the system.
/// </summary>
/// <param name="data">The user creation data.</param>
/// <returns>The created user object.</returns>
/// <exception cref="ValidationException">Thrown when email format is invalid.</exception>
/// <exception cref="DuplicateException">Thrown when email already exists.</exception>
/// <example>
/// <code>
/// var user = await userService.CreateUserAsync(new CreateUserDto
/// {
///     Email = "john@example.com",
///     Name = "John Doe"
/// });
/// </code>
/// </example>
public async Task<User> CreateUserAsync(CreateUserDto data)
{
    // implementation
}

Compatibility

Codex: ✅
Claude Code: ✅

documentation-writer

🇯🇵 日本人クリエイター向け解説

🎯 このSkillでできること

📦 インストール方法 (3ステップ)

📖 Skill本文(日本語訳)

Documentation Writer Skill

説明

トリガー

プロンプト

README テンプレート

JSDoc コメント

C# XML ドキュメント

タグ

互換性

Documentation Writer Skill

Description

Trigger

Prompt

README Template

JSDoc Comments

C# XML Documentation

Tags

Compatibility