売れるREADME
READMEはドキュメントではありません。たまたまgitリポジトリに存在するランディングページです。
訪問者は約15秒でスターを付けるか、試すか、去るかを決断します。
スクロールせずに見える範囲(above the fold)は、スターを獲得するためのものでなければなりません。
ドキュメントはスクロール先か、docs/に配置してください。
15秒テスト
書き始める前に、以下の質問にそれぞれ一行で答えてください。答えられなければ、READMEも答えられません。
- それは何? 形容詞なしの一文。「Zigで書かれたAIエージェント向けヘッドレスブラウザ」
- なぜ存在する? ユーザーの言葉で表現した、それが取り除く苦痛。「Chromeはタブごとに500MB消費するが、エージェントは50タブ必要とする。」
- 動く証拠。 デモGIF、ベンチマーク数値、またはbefore/after。機能一覧ではありません。
- 試すためのワンコマンドは?
npx ...、pip install ...、curl ... | sh、docker run ...。
構造(この順序、例外なし)
# プロジェクト名
一行ピッチ。(何 + 誰のため + フック)
[デモGIFまたはスクリーンショット — 10秒未満、結果を示し、セットアップは見せない]
## インストール ← ワンコマンド、コピペ可能、隠れた前提条件なし
## なぜ ← 3~5行:苦痛、既存の代替手段、これが異なる理由
## 使い方 ← 最も一般的なユースケース、実行可能な例として
## 機能 ← オプション、短い箇条書き、マーケティング用語なし
## 仕組み ← オプション、1段落または1図
## 比較 ← オプション、2~3の代替手段とのテーブル、トレードオフを正直に
## コントリビューション / ライセンス
ルール
- ピッチ行: 15語以内。カテゴリと差別化要因を明記。「爆速」「強力」「シンプル」を避ける。数字があれば使う:「Claude Codeのトークン使用量を40%削減。」
- デモが先、文章は後。 GIFまたはスクリーンショットはピッチの直下に配置。デモがまだない場合は、ローンチ前に作成(
demo-gifスキルを参照)。デモのないREADMEのコンバージョン率は、あるものの数分の一です。 - インストールはワンブロック、ワンコマンド。 APIキーや設定ファイルが必要な場合は、同じブロック内でそれも表示。隠れた前提条件は、クローン後に人々が離れる理由の第1位です。
- 「なぜ」は、すでに解決策を持っている人向けに書く。 代替手段の名前を挙げる。それらが得意なことを述べる。そして、これが彼らが持っていない唯一のことを述べる。読者は競合に対して公正なREADMEを信頼します。
- 見出しに絵文字は使わない(プロジェクトが意図的に遊び心のある場合を除く)。ピッチより上にバッジを置かない(バッジの壁は訪問者が最初にスクロールして通り過ぎるものです)。ピッチの下に2、3個のバッジはOK:ビルドステータス、バージョン、ライセンス。
- 1つの実例は10の機能箇条書きに勝る。 入力→出力を示す。読者が実際に実行したくなるものにする。
- そうでないものも明記する。 正直な範囲の一文(「Playwrightの代替ではありません。まだJSレンダリングはありません」)は、Hacker Newsでの最初の敵対的なコメントを先制します。
- ある社会的証明にはリンクを張る。 「X社で使用」、ベンチマーク、Show HNのスレッド。架空のものは作らない。
- 初回訪問者に不要なものは、上部60行に入れない。 アーキテクチャ、ロードマップ、FAQ、変更履歴:すべて下か他の場所に。
コンバージョンを損なうアンチパターン
- 背景や歴史の段落で始める。
- 目次をページの最初に置く。
- 「インストール」の前に「機能」。
- 使用されるためのツールなのに「まずリポジトリをクローン」から始まるインストール手順(開発用ではない)。
- 結果ではなく設定ファイルのスクリーンショット。
- マーケティング口調(「革新的」「次世代」「簡単に」)。
- 死んだプレースホルダー(「TODO: デモを追加」)。
手順
- 現在のREADME(ある場合)とコードのエントリポイントを読み、15秒テストの4つの答えを抽出する。
- ピッチ行を草案する。3つのバリエーションを書き、最も具体的な名詞と最も少ない形容詞のものを選ぶ。
- インストール、次に使い方、次になぜを書く。インストールの全コマンドを実行し、クリーンなディレクトリから動作することを確認する。
- ピッチの下にデモを挿入する。存在しない場合は
TODO(demo)マーカーを追加し、ユーザーにこれがローンチを妨げることを伝える。 - スクロールせずに見える範囲から、「見知らぬ人がこれを決断するために必要か?」という質問に失敗するものをすべて削除する。
- 上部60行を懐疑的なエンジニアとして読む。タブを閉じさせる最初の箇所を修正する。
出力
完全なREADME.mdを返す。次に、変更した内容とユーザーがまだ提供しなければならないもの(デモGIF、ベンチマーク数値、実ユーザーの声)を、最大5つの箇条書きでリストする。