READMEを下書きするプロンプト
新しいリポジトリを作ったものの、「README.mdを後回しにしていたら結局書かないまま」ということはないでしょうか。プロジェクトの概要や使い方は頭の中に入っているのに、いざ文書化しようとすると意外と時間がかかるものです。
このプロンプトは、プロジェクトの概要と技術スタックを伝えるだけで、AIに概要・インストール方法・使い方までまとめたREADME.mdの下書きを作成させるものです。コピーしてそのままChatGPTやGeminiなどに貼り付けて使えます。
コピペ用プロンプト
以下のコードブロックの中身をそのままコピーして、AIチャットに貼り付けてください。【 】で囲まれた部分はご自身の状況に合わせて書き換えてください。
あなたは経験豊富なOSS開発者です。以下の情報をもとに、README.mdの下書きを作成してください。
【プロジェクト名】: task-flow-cli
【プロジェクトの概要（何をするものか）】: ターミナルから使えるシンプルなタスク管理CLIツール。タスクの追加・完了・一覧表示ができる
【使用している技術スタック】: Node.js, TypeScript, Commander.js
【セットアップ手順（コマンドの箇条書き）】: npm install -g task-flow-cli でインストール、task add "タスク名" でタスク追加、task list で一覧表示
【ライセンス】: MIT
# 出力してほしい内容
以下の構成でREADME.mdを作成してください（Markdown形式）。
1. プロジェクト名とバッジ想定欄（実際のバッジは後で挿入する前提で、プレースホルダーコメントでよい）
2. 概要（1〜2文の要約＋詳しい説明）
3. インストール方法
4. 使い方（コード例つき）
5. 技術スタック
6. コントリビューション方法（一般的な内容でよい）
7. ライセンス
# 出力フォーマット
Markdown形式で、コードブロックを適切に使って出力してください。
# 制約条件
- 実際のコマンドやコード例は、入力された情報の範囲で正確に記載する
- 情報が不足している項目（コントリビューションガイドライン等）は、一般的なテンプレート文言で補ってよい使い方3ステップ
- 上記プロンプト内の【プロジェクト名】【プロジェクトの概要】【使用している技術スタック】【セットアップ手順】【ライセンス】を、実際のプロジェクト情報に書き換えます。
- ChatGPTやGeminiなどのAIチャットに貼り付けて送信します。
- 出力されたMarkdownをリポジトリのREADME.mdに貼り付け、実際のバッジやスクリーンショットなどを追加して仕上げます。
入力例と出力サンプル
入力例（プロジェクトを変更した場合）
【プロジェクト名】: markdown-to-slide
【プロジェクトの概要（何をするものか）】: MarkdownファイルをブラウザベースのスライドショーHTMLに変換するツール
【使用している技術スタック】: Python, Jinja2
【セットアップ手順（コマンドの箇条書き）】: pip install markdown-to-slide でインストール、md2slide input.md でスライド生成
【ライセンス】: MIT出力サンプル（抜粋）
概要
markdown-to-slideは、普段書き慣れたMarkdownファイルを、ブラウザで表示できるスライドショーHTMLに変換するCLIツールです。インストール方法
pip install markdown-to-slide
カスタマイズのコツ
- スクリーンショットやデモGIFを入れる予定がある場合は、「画像を挿入する箇所にプレースホルダーコメントを入れて」と依頼すると、挿入位置が分かりやすくなります。
- 英語版READMEも欲しい場合は、「日本語版の後に英語版も続けて作成して」と追記すると、多言語対応のREADMEになります。
- API仕様やオプション一覧が多いツールの場合は、「オプション一覧を表形式で」と出力フォーマットに指定すると見やすくなります。
注意点
- 社内限定のプライベートリポジトリ用README作成の場合、社外秘のインフラ情報やAPIキーなどが本文に含まれないよう注意してください。
- 生成されたセットアップ手順は、実際に手元で動作確認してから公開してください。
- OSSとして公開する場合、ライセンスの選定は法務的な判断を伴うため、必要に応じて社内の確認を経てください。
