説得力のあるプロジェクト説明の書き方

10秒で読者を引きつけるREADME説明を作成します。ワンライナーの公式、機能ハイライト、比較文、検索最適化された説明を解説します。

Best Practices

詳細な説明

読者を引きつけるプロジェクト説明を書く

説明はタイトルとバッジの次に最初のテキストです。開発者は約10秒で読み続けるか離れるかを決定します。優れた説明は3つの質問に答えます:何をするか?誰のためか?なぜ使うべきか?

ワンライナーの公式

何となぜを組み合わせた一文から始めます:

[何であるか] that [主要な利点] for [対象者]。

機能ハイライトパターン

ワンライナーの後に、3-5の主要機能を任意でリストします。

比較文

既存のツールを改善する場合はそう述べます。敬意を持ち、事実に基づいた比較をしてください。

避けるべきこと

  • 曖昧な説明:「開発者のためのツール」-- 汎用的すぎる
  • 機能の羅列:説明に20の機能をリスト
  • マーケティング用語:「革命的」「画期的」
  • 前提:読者が問題領域を知っていると仮定しない

検索最適化

開発者が検索するキーワードを含めます。

ユースケース

曖昧または冗長なプロジェクト説明を、潜在的ユーザーに即座に価値を伝え、検索で上位に表示される、機能ハイライト付きの説得力あるワンライナーに書き直す場合。

試してみる — README Generator

フルツールを開く