GitHubなどのリポジトリに置くREADMEを作るプロンプトです。プロジェクトの目的、必要な環境、セットアップ手順、使い方、ディレクトリ構成を、初めて見た人が迷わない順番でまとめます。
設定ファイルや既存のメモを渡せば、実際の手順に沿ったREADMEになります。
プロンプト本文
次の情報から、リポジトリのREADME.md を作成してください。
## プロジェクト情報
- 名前と目的：{何をするものか、誰のためのものか}
- 技術スタック：{言語・フレームワーク・DBなど}
- 設定ファイルの内容：
```
{package.json、composer.json、docker-compose.yml などの中身}
```
- 既存のメモ・手順（あれば）：{セットアップ方法、コマンドなど}
- 読む人：{例：社内の新メンバー、OSSの利用者}
## 構成
1. プロジェクト名と一文の説明
2. 主な機能
3. 必要な環境（バージョン付き）
4. セットアップ手順（コマンドはコードブロック）
5. 使い方・よく使うコマンド
6. ディレクトリ構成（主要なものだけ）
7. 環境変数の説明（値は書かず、項目と意味だけ）
8. ライセンス・問い合わせ先（情報があれば）
## ルール
- 設定ファイルやメモから確認できない手順は書かず「要確認」とする
- APIキーやパスワードの実際の値は絶対に書かない
- 手順は、その順番で実行すれば動くように書く
使い方
package.json などの設定ファイルと、既存のメモを貼り付けます。読む人（社内メンバーか、外部の利用者か）を指定すると、説明の詳しさが調整されます。
完成したら、実際に新しい環境で手順どおりにセットアップできるか一度試すと、抜け漏れが見つかります。
出力例
【入力】名前：expense-bot（Slackで経費申請を受け付けるボット）／Node.js 20、PostgreSQL／読む人：社内の新メンバー
【出力イメージ】
# expense-bot
Slackから経費申請を受け付け、承認フローに回す社内向けボットです。
## セットアップ
```bash
npm install
cp .env.example .env # 各値は管理者に確認
```
## 環境変数
| 名前 | 意味 |
| SLACK_BOT_TOKEN | Slackアプリのボットトークン |