README 怎麼寫：項目 README.md 生成提示詞（快速開始、配置表、常見問題一次寫全）
開源項目準備發佈、或內部項目要交接時用：根據項目文件生成一份新人照着就能跑起來的 README.md，命令只取自項目裏真實存在的腳本，缺的資訊列成待補充清單。
通用大模型 對話模型通用
【角色】你是一名開發者體驗（DX）工程師，評判 README 的唯一標準是：一個從沒見過這個項目的新人，能否在 10 分鐘內照着把它跑起來。 【項目資料】 - 項目一句話用途：[項目用途] - 目標讀者：[開源用戶/公司內部同事/甲方運維] - 技術棧與運行環境：[語言框架與版本] - 依賴清單與腳本文件（package.json、pyproject.toml、Makefile、docker-compose.yml 等，原樣粘貼）： [粘貼配置文件] - 環境變量示例文件（.env.example，刪掉真實值）： [粘貼環境變量示例] - 目錄結構（tree -L 2 的輸出）： [目錄結構] - 已有的說明或注意事項（沒有就寫無）：[已有說明] 【任務】按下面的章節寫 README.md，讀者用不到的章節可以刪掉並說明理由： 1. 標題 + 一句話說明「它解決什麼問題、給誰用」，必要時加徽章佔位。 2. 功能特性：3–6 條，寫用戶能感知的能力，不寫內部實現。 3. 快速開始：前置依賴及最低版本 → 克隆 → 安裝 → 配置 → 啟動 → 如何確認啟動成功（訪問哪個地址、看到什麼輸出）。 4. 配置說明：環境變量表（變量名 | 是否必填 | 預設值 | 說明 | 示例）。 5. 常用命令：開發、測試、構建、代碼檢查、數據庫遷移，各一行說明。 6. 目錄結構：只解釋關鍵目錄，每個一句話。 7. 部署（如適用）與常見問題 FAQ（端口占用、依賴版本衝突、權限問題等，結合技術棧寫 3–5 條）。 8. 貢獻方式與許可證（開源項目才寫；許可證以倉庫裏的 LICENSE 為準，不確定就留佔位）。 【約束】 - 所有命令必須能在我給的配置文件裏找到依據；找不到的寫成「TODO：確認 xxx 命令」，絕不編造腳本名或端口號。 - 命令放在代碼塊裏，一行一條，可以直接複製；涉及不同操作系統的命令分別給出。 - 不出現真實密鑰、內網地址和個人聯絡方式。 - 語言簡潔，避免「強大的」「極致的」這類營銷詞。 【輸出格式】 先輸出完整的 README.md（放在一個 markdown 代碼塊裏），再單獨列出「需要我補充或確認的資訊」清單。
高亮處換成你自己的內容：[項目用途]、[開源用戶/公司內部同事/甲方運維]、[語言框架與版本]、[粘貼配置文件]、[粘貼環境變量示例]、[目錄結構]、[已有說明]
ChatGPT Plus 充值
已被複製 1 次
使用說明
怎麼填變量：最有用的輸入是配置文件原文——package.json 裏的 scripts、Makefile 的目標、docker-compose.yml 的端口映射，AI 才能寫出真實可用的命令，而不是通用的 npm start。[目標讀者] 會改變寫法：給運維看的要寫清端口、數據目錄和日誌位置；給開源用戶看的要把截圖和使用示例放前面。
常見坑：
- AI 最常見的錯誤是編造命令和預設端口，所以模板裏要求它找不到依據就寫 TODO，拿到結果後逐條核對。
- 環境變量示例一定先把真實值換掉再粘貼。
- 寫完後請一位沒接觸過項目的同事照着做一遍，卡住的地方就是 README 要補的地方。
追問技巧：追問「站在第一次運行就失敗的新人角度，列出最可能卡住的 5 個地方並補進 FAQ」；開源項目還可以要求「再寫一個英文版」。
示例輸出
示例，僅供參考（節選）
快速開始
需要 Node.js 20 及以上、pnpm 9。
bash
git clone <倉庫地址>
cd order-service
pnpm install
cp .env.example .env # 按下表填寫
pnpm dev看到 Listening on http://localhost:3000 即啟動成功。
| 變量名 | 必填 | 預設值 | 說明 |
|---|---|---|---|
| DATABASE_URL | 是 | 無 | PostgreSQL 連接串 |
| LOG_LEVEL | 否 | info | 日誌級別 |
需要確認：TODO：確認生產環境的構建命令（package.json 中沒有 build 腳本）。
同款作品
用這條提示詞做出來的作品；原作者會因此獲得積分
還沒有同款，來做第一個。
0 條評論
還沒有評論，來搶沙發～