如何用3个提示词让ChatGPT写出专业级别的技术文档？

你信我

说实话,我以前写技术文档就是个灾难，吧，去年某东买了个智能家居套装，愣是花了三个晚上看官方手册，最后发现还不如直接问客服来得快，后来被老板逼着写项目接，口文档，那叫若干个痛苦，写了八千字，同事看了说“这玩意儿是人看得东西吗”。

直到我琢磨透了ChatGPT那套提示词的门道，才算真正开了窍。

你别看网上那些教程动不动就甩出几十个提示词模板，神马“，你是一个资深架构师”“请用Markdown格式输出”，乱七八糟堆一块儿。

我试过，出来的东西要么太啰嗦，要么压根看不懂。

其实真正管用的就三个提示词，你把它当成三把钥匙，一把一把塞进去就行了。

第一个提示词，你得明确告诉ChatGPT“你是谁”。

不是那种虚头巴脑的“你是一个AI助手”，那没用你得具体到职称、场景甚至语气。

比如写技术文档，我一般这么写：“你现再是一个在硅谷干了七八年的资深DevOps工程师，专门负责给银行系统写高可用架构文档，说话直接，讨厌废话，喜欢用实际的代码片段解释问题。

”这一下子，ChatGPT就从一个万能聊天机器人变成了一个带着脾气的老程序员。

我上个月接了个边缘计算的活儿，就是用这个法子，它给我产出的Kubernetes部署文档，连我那个挑剔的甲方都夸“专业得像人写的一样”。

（不过后来我发现它跑偏过一回，写出来的步骤里竟然让我用旧版API，还好我留了个心眼检查了一遍——这个我真没想到。

）

第二个提示词，你要告诉它“文档长啥样”。

这个很多人忽略。

我习惯写一句：“请用以下结构输出：开头两句话概括问题，中间分环境搭建、配置步骤、验证方法三个部分，每个部分下面用表格列出关键参数，最后放一个常见问题的Q&A。

禁止使用任何复杂术语，每个技术名词第一次出现时用括号加解释。

”有了这个框架，ChatGPT就不会自由发挥成散文或者小说。

我朋友就踩过坑，他扔了一句“帮我写个Docker部署文档”，结果AI给了一大堆理论，连怎么安装Docker都写了十页，气得他直骂娘。

后来他按我说的加上这个提示词，五分钟就拿到了能用上的文档。

第三个提示词最关键，你得给它“喂一个例子”。

这个例子不用多，三五句话就行。

比如我写API文档，我会先丢一个我自己写过的例子片段进去：“这是我的一个例子：/users接口，POST方法，参数包括username（字符串，必填）、age（整数，可选），返回状态码几十表示创建成功，返回体包含userId。

请严格按照这个格式，把下面这个新接口写出来。

”ChatGPT看到例子，就像人看到了样板房，不会瞎创新了。

我去年做物联网项目，用这个法子一口气搞定了二十多个设备接口文档，效率绝绝子。

不过有一次我忘了给例子，它自己发挥，把返回字段的顺序全打乱了，害得测试组那边报错报了一下午，那次真把我整不会了。

，对了我想起一件小事。

五月初上海那几天热得要死，我开着空调在家试着用这三个提示词写一份关于Redis集群迁移的文档，结果第三个小时写得我，眼睛发酸，就去冰箱拿了个冰西瓜，回来发现ChatGPT还在那老老实实等着我输入下一步。

你看，它多听话，关键是你得把话说明白。

有时候我跟我老婆聊天都对付不过她，但跟ChatGPT沟通反而顺畅多了——大概是因为它不会翻白眼。

其实这三个提示词说白了就是：身份要具体、结构要清晰、例子要

（不好意思，老公摔倒了，稍等）

实在。你把这三点揉进一句话里，比如“你是一个干了五年嵌入式系统的工程师（身份），请用步骤+代码的方式写一个部署指南（结构），参考这个格式：第一步干啥，代码是什么，最后输出什么（例子）”。这样一组合，出来的文档基本不用大改。我试过最狠的一次，直接复制粘贴到公司的知识库里，连同事都以为是哪个高级外包写的。

不过你也别太依赖它。

上一回我让它写一个关于负载均衡的配置文档，结果它把Nginx的upstream模，块参数写错了，weight和max_fails的顺序搞反了。

还好我生产环境下先做了个测试，不然上线那天我估计得被老板骂到怀疑人生。

所以啊，这三个提示词只是帮你省去写草稿的时间，核对和微调的那几步，还得靠自己。

就像做菜，食谱再好，盐放多少也得自己尝。

我小舅子前两天问我要不要买那个很火的智能烤箱，我说你先把说明书看懂了再说吧。

他笑，我跟他讲：你要是会用ChatGPT写文档，连说明书都能让它帮你翻译成人话。

他就试了试，给他家那个意大利烤箱写了份简版操作指南，现在天天在家族群里嘚瑟。

你看，技术文档这玩意儿，说白了就是让机器听人话，反过来人也要学会跟机器唠嗑。

三个提示词不够？

再补一句“别写废话”就行。