説得力のある使用例の書き方

開発者が好む使用例を書く

使用方法セクションは、タイトルの次にREADMEで最も読まれる部分です。開発者はコピー＆ペーストして変更できるコードを探してREADMEをスキャンします。優れた使用例は段階的開示パターンに従います。

段階的開示パターン

レベル1：最小限の動作例（3-5行）

import { compress } from 'my-compressor';

const output = compress('Hello, World!');
console.log(output); // "eJxLSS0u0S1OTgYABZwB9Q=="

レベル2：一般的なユースケース（10-15行）

オプション付きの使用方法を示します。

レベル3：高度な設定（15-30行）

ストリーミング、エラーハンドリング、フレームワークとの統合を示します。

期待される出力を表示

コードが何を生成するかを常に表示します。

現実的なデータを使用

foo、bar、test123を避け、現実的な例を使用してください。

エラーハンドリング

エラーがどのように伝達されるかを示します。

フレームワーク統合

ライブラリが人気のフレームワークと統合する場合、その方法を示します。