✍️ ライティング コミュニティ
llm-doc-writer
LLMが理解しやすいように、CLAUDE.mdやREADME、技術文書、AIアシスタント向け指示書など、AIが読み込むあらゆるドキュメントを効率的に作成するSkill。
📜 元の英語説明(参考)
Write token-efficient documentation for LLM context. Use when creating CLAUDE.md, README, technical docs, agent instructions, or any documentation consumed by AI assistants.
🇯🇵 日本人クリエイター向け解説
一言でいうと
LLMが理解しやすいように、CLAUDE.mdやREADME、技術文書、AIアシスタント向け指示書など、AIが読み込むあらゆるドキュメントを効率的に作成するSkill。
※ jpskill.com 編集部が日本のビジネス現場向けに補足した解説です。Skill本体の挙動とは独立した参考情報です。
⚡ おすすめ: コマンド1行でインストール(60秒)
下記のコマンドをコピーしてターミナル(Mac/Linux)または PowerShell(Windows)に貼り付けてください。 ダウンロード → 解凍 → 配置まで全自動。
🍎 Mac / 🐧 Linux
mkdir -p ~/.claude/skills && cd ~/.claude/skills && curl -L -o llm-doc-writer.zip https://jpskill.com/download/16970.zip && unzip -o llm-doc-writer.zip && rm llm-doc-writer.zip
🪟 Windows (PowerShell)
$d = "$env:USERPROFILE\.claude\skills"; ni -Force -ItemType Directory $d | Out-Null; iwr https://jpskill.com/download/16970.zip -OutFile "$d\llm-doc-writer.zip"; Expand-Archive "$d\llm-doc-writer.zip" -DestinationPath $d -Force; ri "$d\llm-doc-writer.zip"完了後、Claude Code を再起動 → 普通に「動画プロンプト作って」のように話しかけるだけで自動発動します。
💾 手動でダウンロードしたい(コマンドが難しい人向け)
- 1. 下の青いボタンを押して
llm-doc-writer.zipをダウンロード - 2. ZIPファイルをダブルクリックで解凍 →
llm-doc-writerフォルダができる - 3. そのフォルダを
C:\Users\あなたの名前\.claude\skills\(Win)または~/.claude/skills/(Mac)へ移動 - 4. Claude Code を再起動
⚠️ ダウンロード・利用は自己責任でお願いします。当サイトは内容・動作・安全性について責任を負いません。
🎯 このSkillでできること
下記の説明文を読むと、このSkillがあなたに何をしてくれるかが分かります。Claudeにこの分野の依頼をすると、自動で発動します。
📦 インストール方法 (3ステップ)
- 1. 上の「ダウンロード」ボタンを押して .skill ファイルを取得
- 2. ファイル名の拡張子を .skill から .zip に変えて展開(macは自動展開可)
- 3. 展開してできたフォルダを、ホームフォルダの
.claude/skills/に置く- · macOS / Linux:
~/.claude/skills/ - · Windows:
%USERPROFILE%\.claude\skills\
- · macOS / Linux:
Claude Code を再起動すれば完了。「このSkillを使って…」と話しかけなくても、関連する依頼で自動的に呼び出されます。
詳しい使い方ガイドを見る →- 最終更新
- 2026-05-18
- 取得日時
- 2026-05-18
- 同梱ファイル
- 1
📖 Skill本文(日本語訳)
※ 原文(英語/中国語)を Gemini で日本語化したものです。Claude 自身は原文を読みます。誤訳がある場合は原文をご確認ください。
LLM に最適化されたドキュメント
コア原則
| 原則 | ルール |
|---|---|
| 密度 | 最大限の情報、最小限のトークン |
| フォーマット | テーブル > 文章、箇条書き > 段落 |
| 無駄を排除 | 冗長な言葉を禁止 (下記リスト参照) |
| 説明するより示す | コード例 > 説明 |
| 段階的な情報開示 | TOC + 詳細については別のファイル |
禁止パターン
# 冗長な言葉 - 絶対に使用禁止
simplement, il suffit de, en fait, basically, just, simply,
it's important to note, as mentioned, obviously, of course,
please note that, keep in mind, remember that
# 冗長な構造 - 絶対に使用禁止
"This file contains..." (ファイル名から明らか)
"In this section we will..." (ただ実行する)
"The following example shows..." (ただ示す)フォーマットルール
文章よりもテーブル
# 悪い例 - 45 トークン
このシステムは3つのモードをサポートしています。開発モードはホットリロードを有効にし、本番モードはパフォーマンスを最適化し、テストモードは外部サービスをモックします。
# 良い例 - 20 トークン
| モード | 動作 |
|------|----------|
| dev | ホットリロード |
| prod | 最適化 |
| test | モックされたサービス |段落よりも箇条書き
# 悪い例 - 物語調
プロジェクトを実行するには、まず Node.js がインストールされていることを確認し、次に `npm install` で依存関係をインストールし、最後に `npm run dev` で開発サーバーを起動します。
# 良い例 - スキャンしやすい
## 実行
1. 必須: Node.js 18+
2. `npm install`
3. `npm run dev`説明よりもコード
# 悪い例 - 説明
新しいユーザーを作成するには、`createUser` 関数を、`name` プロパティと `email` プロパティを含むオブジェクトとともに呼び出します。
# 良い例 - 示す
```ts
createUser({ name: "Jo", email: "jo@x.com" })
## 構造テンプレート
`CLAUDE.md` / エージェントドキュメントの場合:
```markdown
# プロジェクト名
## スタック
- フロントエンド: React/Vite
- バックエンド: FastAPI
- DB: PostgreSQL
## コマンド
| アクション | コマンド |
|--------|---------|
| 開発 | `npm run dev` |
| テスト | `npm test` |
| ビルド | `npm run build` |
## アーキテクチャ
[簡単な説明、必要に応じて詳細なドキュメントへのリンク]
## 規約
- [ルール 1]
- [ルール 2]段階的な情報開示
長いドキュメント (>200 行) の場合:
# メインドキュメント
## クイックリファレンス
[重要な情報をここに]
## 詳細
[ARCHITECTURE.md](ARCHITECTURE.md) を参照
[API.md](API.md) を参照自己チェック
最終決定する前に、以下を確認してください。
- [ ] 冗長な言葉はないか？
- [ ] テーブルを可能な限り使用しているか？
- [ ] 段落ではなく箇条書きを使用しているか？
- [ ] 説明よりも例を示しているか？
- [ ] 500 行未満か (または分割されているか)？
- [ ] 冗長な情報はないか？
例
修正前/修正後の例については、patterns.md を参照してください。
📜 原文 SKILL.md(Claudeが読む英語/中国語)を展開
LLM-Optimized Documentation
Core Principles
| Principle | Rule |
|---|---|
| Density | Max info, min tokens |
| Format | Tables > prose, bullets > paragraphs |
| No fluff | Ban filler words (see list below) |
| Show don't tell | Code examples > explanations |
| Progressive disclosure | TOC + separate files for details |
Banned Patterns
# Filler words - NEVER use
simplement, il suffit de, en fait, basically, just, simply,
it's important to note, as mentioned, obviously, of course,
please note that, keep in mind, remember that
# Redundant structures - NEVER use
"This file contains..." (obvious from filename)
"In this section we will..." (just do it)
"The following example shows..." (just show it)Format Rules
Tables over Prose
# BAD - 45 tokens
The system supports three modes: development mode which
enables hot reload, production mode which optimizes for
performance, and test mode which mocks external services.
# GOOD - 20 tokens
| Mode | Behavior |
|------|----------|
| dev | Hot reload |
| prod | Optimized |
| test | Mocked services |Bullets over Paragraphs
# BAD - Narrative
To run the project, first ensure Node.js is installed,
then install dependencies with npm install, and finally
start the dev server with npm run dev.
# GOOD - Scannable
## Run
1. Requires: Node.js 18+
2. `npm install`
3. `npm run dev`Code over Explanation
# BAD - Explaining
To create a new user, call the createUser function
with an object containing name and email properties.
# GOOD - Showing
```ts
createUser({ name: "Jo", email: "jo@x.com" })
## Structure Template
For CLAUDE.md / agent docs:
```markdown
# Project Name
## Stack
- Frontend: React/Vite
- Backend: FastAPI
- DB: PostgreSQL
## Commands
| Action | Command |
|--------|---------|
| Dev | `npm run dev` |
| Test | `npm test` |
| Build | `npm run build` |
## Architecture
[Brief description, link to detailed docs if needed]
## Conventions
- [Rule 1]
- [Rule 2]Progressive Disclosure
For long docs (>200 lines):
# Main Doc
## Quick Reference
[Essential info here]
## Details
See [ARCHITECTURE.md](ARCHITECTURE.md)
See [API.md](API.md)Self-Check
Before finalizing, verify:
- [ ] No filler words?
- [ ] Tables used where possible?
- [ ] Bullet points, not paragraphs?
- [ ] Examples over explanations?
- [ ] < 500 lines (or split)?
- [ ] No redundant info?
Examples
See patterns.md for before/after examples.