注册
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 条评论

登录 后参与评论

还没有评论，来抢沙发～