註冊
ChatGPT

用 ChatGPT 寫 README 和技術文檔：貼代碼和目錄生成初稿，安裝步驟必須親自跑一遍，附 4 段可複製提示詞

怎麼用 ChatGPT 寫 README、技術文檔、接口說明？把目錄結構、關鍵代碼和運行方式給它，讓它按章節生成初稿，再逐條核對安裝步驟和示例。本文給 4 段提示詞，強調它沒看到的功能不能寫、命令必須親自跑通。

NNathaniel bigo··原創首發·AI 輔助撰寫
5 分鐘讀完
資料核對於 2026-11-05 · 依據官方文檔與公開資料整理 免費帳號 帳號
本文根據 OpenAI Academy《Prompting》、幫助中心《Working with writing blocks and code blocks in ChatGPT》《Uploading files and audio to ChatGPT》整理，資料核對於 2026-11-05。配圖為本站整理的示意圖，不是介面截圖。本站（bigolab.com）不是 OpenAI 官方網站。官方沒有專門的「寫 README」文章，提示詞是本站示範。

適用於誰

  • 項目做完了，但 README 只有一行標題的個人開發者；
  • 要給團隊寫接口文檔、部署文檔、交接文檔的人；
  • 想讓別人也能把項目跑起來的開源作者。

結論先說

  1. 它只寫它看到的。 目錄結構、入口文件、配置項、關鍵函數，你貼多少它寫多少。沒貼的功能它可能編出來，所以要加一句“只寫我提供的內容”。
  2. 安裝和運行步驟必須親自跑一遍。 新建一個乾淨目錄，完全照着文檔做，卡住的地方就是文檔的錯。
  3. 先出大綱，再寫正文。 常見章節：項目簡介、功能、快速開始、配置、使用示例、目錄結構、常見問題、貢獻方式、許可證。
  4. 許可證你自己選。 不要讓它替你決定；選定後再讓它寫進去。
  5. 不要把密鑰、內部地址寫進文檔。 示例用佔位符。

用 ChatGPT 寫 README 的流程：貼目錄和關鍵代碼、出大綱、寫正文、新建乾淨環境照着做、修正後發佈

圖：本站根據 OpenAI Academy：Prompting 整理的示意圖

一、4 段可以直接複製的提示詞

1. 生成 README 大綱和初稿

請為下面的項目寫 README，用 Markdown。
項目用途：[一句話]。目錄結構：[粘貼 tree 輸出]。運行方式：[安裝命令、啟動命令]。配置項：[環境變量名和含義，不要真實值]。
章節：簡介、功能、快速開始、配置、使用示例、常見問題。
只寫我提供的內容；缺資訊的地方寫【待補充】，不要編功能、命令或版本號。

2. 寫接口文檔

根據下面的接口代碼，寫接口文檔。每個接口寫：路徑、方法、說明、請求參數表（名稱、類型、是否必填、說明）、響應示例、錯誤碼。
代碼裏看不出的參數含義寫【待確認】，不要猜。
[粘貼代碼]

3. 寫代碼註釋

請為下面的函數補充註釋：說明用途、參數、返回值、可能拋出的異常。只加註釋，不要修改代碼邏輯；如果你認為代碼有問題，在最後單獨列出，不要直接改。
[粘貼]

4. 檢查文檔能不能照做

下面是我的安裝文檔。請扮演第一次使用的人，逐步檢查：哪些步驟缺少前置條件（如需要先裝什麼）、哪些命令有歧義、哪些地方沒說在哪個目錄執行。只列問題，不要重寫。
[粘貼]

通用寫法見 /guides/how-to-write-prompts。

二、自己必須核對什麼

文檔發佈前自己要核對的清單：命令親自跑通、版本號、示例輸出、沒有編造功能、沒有密鑰、許可證

圖：本站根據 OpenAI Academy：Prompting 整理的示意圖

  • 命令：全部在乾淨環境裏照着執行一遍；
  • 版本號和依賴：以項目實際的依賴文件為準，不看它的記憶；
  • 功能描述：逐條對照代碼，沒實現的刪掉；
  • 示例輸出：必須是真實運行的輸出，不是它推測的；
  • 連結：文檔裏的連結逐個點開；
  • 敏感資料：密鑰、內部域名、個人路徑，見 /guides/ai-privacy-data-safety-checklist；
  • 許可證：自己確認。

常見問題

Q：能上載整個項目嗎？

聊天裏可以通過輸入框的 + 添加文件，限制見官方《Uploading files and audio to ChatGPT》。更適合大項目的做法是隻貼目錄和關鍵文件。聊天裏寫代碼的邊界見 /guides/chatgpt-write-code-code-blocks-preview-run。

Q：怎麼讓文檔風格統一？

把團隊的文檔模板貼進去，或寫進項目說明，見 /guides/chatgpt-projects。

Q：生成的 Markdown 怎麼複製？

代碼塊有複製按鈕，也可以在寫作塊裏直接編輯後複製，見官方《Working with writing blocks and code blocks in ChatGPT》。

Q：免費版夠用嗎？

夠用；文檔很長時分章節寫，需要更多額度可以看看 /chongzhi/chatgpt-plus。

參考資料

  • OpenAI Academy：Prompting — https://openai.com/academy/prompting/
  • OpenAI 幫助中心：Working with writing blocks and code blocks in ChatGPT — https://help.openai.com/en/articles/20001246-working-with-writing-blocks-and-code-blocks-in-chatgpt
  • OpenAI 幫助中心：Uploading files and audio to ChatGPT — https://help.openai.com/en/articles/8555545-file-uploads-faq

Nathaniel 的更多內容

  1. 01

    Claude Code 在 Windows 上的常見坑：Git Bash 還是 PowerShell、路徑反斜槓、假報錯、WSL 怎麼選

    Windows 上用 Claude Code，裝好之後最容易踩的是：用哪個 shell、路徑寫法不一致、grep 沒匹配就報錯、鉤子沒生效、WSL 和原生怎麼選。本文逐條按官方文檔整理原因和處理辦法，附三段提示詞和一張對照表。

    Claude0
  2. 02

    Claude Code Hooks 實戰「提交前自動跑測試」：PreToolUse 攔住 git commit，測試不過就退出碼 2，附 Windows 注意點

    只寫一個完整例子：讓 Claude Code 每次要執行 git commit 之前，先自動跑項目測試，沒通過就攔下並把輸出交給它修。本文按官方 Hooks 文檔給出腳本、settings.json 配置、測試方法、排錯和 Windows 的兩處坑。

    Claude0
  3. 03

    Claude Code 自定義斜槓命令與 Skill 實戰：從零寫一個「生成更新日誌」的 /release-notes，含傳參、預執行命令和調試

    概念看過了，還是不知道從哪下手？本文按 Claude Code 官方「Extend Claude with skills」寫一個完整可用的例子：用 /release-notes 根據 git 記錄生成更新日誌，覆蓋目錄、frontmatter、傳參、預執行命令、預授權和調試。

    Claude0
  4. 04

    Claude Code 部署網站：先寫 Dockerfile 和 compose 在本機跑通，再按清單上雲伺服器，別讓它直接改線上

    想讓 Claude Code 幫你把網站部署到雲伺服器。本文只寫通用做法，按 Docker 官方文檔講：讓它寫 Dockerfile、.dockerignore 和 compose，在本機跑通，端口和數據卷怎麼設，再給出上線清單，並說明為什麼不要讓它直接動線上機器。

    Claude0
  5. 05

    Claude Code 寫爬蟲與數據清洗：先查 robots.txt 和網站條款，控制頻率，原始數據留一份再清洗

    想讓 Claude Code 寫爬蟲抓數據再清洗。本文先講合規：robots.txt 不是授權也不是安全措施、網站條款要自己讀；再講怎麼用 Python 標準庫檢查規則、小樣本先試、儲存原始數據，以及用 pandas 清洗，附四段提示詞。

    Claude0
  6. 06

    Claude Code 寫 Chrome 擴展：按 Manifest V3 起步，加載未打包的擴展，改了哪些文件要重新加載

    想讓 Claude Code 幫你寫一個 Chrome 擴展。本文按 Chrome 官方擴展文檔講：manifest.json 的最小寫法、在 chrome://extensions 加載未打包的擴展、哪些改動要刷新、怎麼看控制檯和報錯，再給四段提示詞，以及權限要盡量少。

    Claude0

同產品的其他教學

  1. 01

    OpenAI API 的 token 怎麼算、怎麼估算費用：input_tokens 計數接口、tiktoken 和隱藏的輸出 token

    發請求前想知道會用多少 token？官方有 Responses 的 input_tokens 計數接口，能把文字、圖片、文件、工具定義一起算準；本地 tiktoken 只適合純文本。本文給 Python 和 Node 示例，講輸出 token 為什麼可能比看到的多，以及怎麼估算費用。

    ChatGPT0
  2. 02

    OpenAI API Node.js / TypeScript 快速上手：npm install openai、example.mjs 第一個請求，到流式、函數調用、聯網搜尋

    用 Node.js 調 OpenAI API：設定 OPENAI_API_KEY 環境變量，npm install openai，新建 example.mjs，用 client.responses.create 發出第一個請求。並列出圖片、文件、流式、函數調用、聯網搜尋和錯誤捕獲的 Node 寫法。

    ChatGPT0
  3. 03

    OpenAI API 用量層級（usage tiers）與速率限制怎麼提升：Free、Build、Launch、Grow 和後台 Limits 頁

    OpenAI API 的限速不是固定的：官方按累計購買額度把組織分成 Free、Build、Launch、Grow 四個層級，達到門檻自動升級。本文講 RPM、TPM 等指標、怎麼在後台查自己的限額、響應頭怎麼讀、花費上限和限速的區別，以及怎麼讓限額變得夠用。

    ChatGPT0
  4. 04

    OpenAI API 報錯 400、401、403、404、429、500、503 怎麼排查：按官方錯誤碼頁逐個看原因和解決辦法

    調用 OpenAI API 返回 400、401、403、404、429、500、503，各自什麼意思？本文按官方 Error codes 頁，每個狀態碼一節，寫清官方給的原因和解決辦法，並說明 404 在官方頁面裏的位置、429 的六種情形，附 Python 和 Node 的錯誤捕獲寫法。

    ChatGPT0
  5. 05

    OpenAI Realtime API 是什麼：語音到語音會話、WebRTC 與 WebSocket、臨時密鑰和事件機制

    Realtime API 讓模型直接處理音頻，做可以隨時打斷的語音助手。本文按官方文檔講它是什麼、什麼時候用、瀏覽器接入的流程、session 與事件、可用聲音、60 分鐘會話上限、安全標識，以及它和轉寫、文字轉語音的分工。

    ChatGPT0
  6. 06

    OpenAI 圖像生成 API 怎麼用：gpt-image 系列、images.generate 與 Responses 工具、尺寸質素和遮罩編輯

    用 OpenAI API 生成或編輯圖片，有 Image API 和 Responses 裏的 image_generation 工具兩條路。本文按官方文檔給 Python 和 Node 示例，講 gpt-image 模型選擇、尺寸質素格式參數、遮罩編輯、被攔截時的錯誤處理，以及需要組織驗證的提醒。

    ChatGPT0

0 條評論

登入 後參與評論

還沒有評論，來搶沙發～