最近在做内部工具的项目文档,想用GPT-4批量生成接口说明和操作手册。我试了“请用专业、清晰的风格写文档”,但出来的内容还是特别“AI味”——动不动就“此外”“值得注意的是”,句式绕口,像英文机翻的。我尝试在prompt里加“像人类工程师写的一样”,但结果更飘了。有没有大佬试过什么具体技巧,比如给范例、限定句式长度、或者让它模仿某个开源项目的README风格?求个能落地的prompt模板,救救孩子。
用Prompt让AI写技术文档,总是一股翻译腔怎么办?
全部回复
共 22 条给范例是最管用的,别让它自由发挥。我之前搞API文档也踩过这个坑,后来直接把Vue官方文档或者Requests库的README截一段塞进prompt里,说“严格按这个风格写”,输出立刻正常了。另外你试试把“专业清晰”这种虚词全删掉,改成“每段不超过三句话,用主动语态,动词开头,禁止使用‘此外’‘值得注意的是’这类连接词”,它就会老实很多。还有个土办法,就是先让它写一版,然后你自己改两句,把改完的再扔回去说“模仿这个修改后的语气重写全文”,两轮下来基本就没人味了。不过说实话,批量生成的东西多少还是有点模板感,真要追求完全像人写的,不如让它列好技术要点,你自己串一遍逻辑,反而更快。
给范例是最管用的,我一般直接丢一段你想要的文档开头,再让它照着续写,比说一万句“不要机翻”都强。还有个小技巧是限定它用短句,比如“每句话不超过20个字”,效果立竿见影。你可以试试让它模仿GitHub上star多的那种README,语气马上就接地气了。对了,写完记得让它自己通读一遍,把“此外”“值得注意的是”全删掉,这步不能省。
给范例是真的管用,我之前也被这问题折磨过。你试试在prompt里直接甩一段你们项目里写得最顺手的README,然后告诉它“按这个风格和结构写”,比你说一百句“别机翻”都强。还有个土办法,就是让AI先写一版,然后你自己动手改个两三段,把改完的扔回去当few-shot示例,它学得特别快。另外句式长度这个我也试过,加一句“每句话不超过25个字,多写短句”能明显减少那种绕口的从句套从句。但说实话,最管用的还是给它一个具体的“人设”,比如“想象你是个在创业公司干了五年的后端,给同事写交接文档”,比“专业工程师”这种抽象词好使。最后,别指望一次到位,我一般都要来回改两轮,第一轮让它出框架,第二轮专门挑那些“此外”“值得注意的是”挨个删,然后加一句“删掉所有连接词开头的句子”,效果立竿见影。
给范例是最快的,找个你看着顺眼的开源项目README,截一段直接扔进prompt里让它模仿,比你说一百遍“像人写的”都管用。另外可以试试在prompt里加一句“用短句,每段不超过三行”,能明显压掉那种绕来绕去的翻译腔。我之前还试过让它先列大纲再逐段写,比一次性生成整篇要好控制得多,你可以先拿一个小接口试试水。
给范例是最管用的,别让它自由发挥。我一般会先扔一段自己写的文档进去,再跟一句“按这个风格重写”,它立马就老实了,句式也不绕了。
另外你可以试试在prompt里加“用短句,每段不超过三行”,能压住那种翻译腔的飘感。我上次拿Redis的README当模板,效果比直接说“像人写的”强太多,你可以找个你看着顺眼的开源项目试试。
要是还不行,就让它先列提纲再写,别一步到位,分段约束会好控制很多。
给范例是真的管用,我之前直接丢给它一段Vue官方文档的写法,再让它照着写接口说明,基本就没什么翻译腔了。还有就是限定句子别超过二十个字,它一绕口就提醒它“短句,别用副词”,效果立竿见影。你那个“像人类工程师”的prompt太虚了,得给个具体的锚点,比如让它想象自己在给同事发Slack消息,语气瞬间就接地气了。
给范例这个方向是对的,但别只丢一个README进去,你得挑那种“有缺陷”的真实文档。比如你们内部某个老工程师写的、带点个人口头禅但逻辑清楚的注释,让它照着那个调性来,AI反而能学会那种“人味儿”。另外我试过在prompt里明确写“每段不超过三句话,禁止使用‘此外’‘值得注意的是’这类连接词,能用冒号或破折号就别用从句”,效果立竿见影,比让它“像人类”管用多了。还有一个偏方,你让它先写一版英文的,然后自己翻译成中文,但翻译时故意保留一些英文语序的别扭感,再反过来让AI改顺——它改的时候会倾向于用短句,比直接生成的中文自然得多。至于句式长度,我一般会加一句“句子超过20个字就拆开,除非是技术术语必须完整”,这样能强制打断它那种连绵不绝的排比结构。最后,你还可以试试在prompt里塞一个具体场景,比如“想象你在给一个刚入职的实习生解释这个接口,他不懂你的业务背景”,这样它会自动降低抽象程度,多写操作步骤而不是概念描述。反正我最近用这套组合拳,生成的文档基本能直接过评审,就是得花点时间调第一次的范例,后面就省心了。
给范例确实是最管用的,你直接贴一段你们团队之前写得比较顺手的接口文档,让它照着这个风格和结构来写,比啥prompt都强。另外可以把“此外”“值得注意的是”这些词直接拉黑,在prompt里加一句“禁止使用过渡性套话,每个句子都要有具体信息”。句式长度那个我也试过,说“每句话不超过30个字”,效果还行,但别太死板,不然读起来跟电报似的。
追问:用Prompt让AI写技术文档还能怎么调教?
给范例是最管用的,我一般直接丢一段自己写好的文档片段进去,让它照着那个语气和结构来,比什么形容词都强。另外你试试把“此外”“值得注意的是”这些词拉黑,在prompt里写“禁止使用连接词和总结句式”,效果立竿见影。还有一个土办法,生成后自己动手删掉每段开头那句废话,比反复调prompt快多了。
给一段你满意的文档当范例塞进prompt里,比说一百句“像人写的”都管用。
我试过丢个Linux手册的风格进去,输出立刻接地气,你试试。
给范例是最管用的,我试过丢给它一段你想要的文档片段,再让它照着写,比描述风格强多了。句式长度也得限制,比如“每句话不超过25个字”,能有效减少那种绕来绕去的结构。另外别说“像人类”,它只会更抽象,直接指定某个开源项目的README风格,比如Vue或axios那种,反而落地。你试试在prompt里加一句“禁止使用‘此外’‘值得注意的是’这类连接词”,效果立竿见影。
给一段你项目的真实README当few-shot示例,比啥提示词都管用。我试过直接丢给它一段旧文档,效果立竿见影。
我之前也踩过这坑,后来发现光靠形容词没用,得给它“抄作业”。直接把你们内部写得最好的那份文档截一段塞进prompt里,告诉它“按这个风格来”,比啥“像人类”都管用。另外句式长度得卡死,比如“每段不超过三行,别用‘此外’这种连接词”,我试了效果立竿见影。你还可以试试让它先列大纲,你审完再让它填内容,比直接生成整篇靠谱得多。
给范文最管用,直接甩一段你想要的README,再让它照着写,语气立马就对了。
给一两个真实项目的README当范例塞进prompt里,比说“像人写的”管用十倍。
给范例这个方向是对的,但别只给一段“标准答案”,你得给它几个反面例子。我之前做API文档时,先丢给它一段我们自己团队写的、带点口语化注释的README,再让它按那个语感去改写,效果比单纯说“别机翻”强多了。另外,你试试在prompt里明确要求“每个段落不超过三句话,能用主动语态就别用被动”,再把“此外”“值得注意的是”这些词直接拉黑,告诉它“出现一次就重写”。还有个偏方,让它先假装是个用了这个工具三年的老用户,在跟新同事讲解,这个视角转换比任何风格指令都管用。最后,批量生成的话,建议一次只给一个接口,让它先列提纲再填充,不然它容易为了凑结构把句子越写越绕。你那个“像人类工程师”的指令太虚了,人类工程师写文档也分啰嗦型和干脆型,你得先想清楚自己要哪种。
给它喂几段你们项目里老工程师写的文档当范例,比啥咒语都管用。
给范例是最有效的,直接扔一段你认可的开源项目README进去,让它照着那个语气和结构写,比什么形容词都管用。句式长度可以限制一下,比如“每句话不超过25个字,不要用从句”,能明显减少那种绕来绕去的感觉。另外我试过在prompt里加“写完后删掉所有连接词和过渡句,检查一遍,只保留必要的信息”,出来的效果会硬朗很多。你还可以让它先列提纲再逐段填充,别让它一口气生成全文,那股翻译腔多半是长文本里攒出来的。
给范例确实是最有效的,我之前试过让它模仿Spring官方文档的段落结构,输出立刻就不一样了。不过光给风格还不够,你得在prompt里明确禁止那些连接词,比如直接写“不要使用‘此外’、‘值得注意的是’这类过渡短语”,效果立竿见影。还有一个偏方是让它先写一个粗糙的初稿,然后你指定某一段,要求它用“口语化但技术上精准”的语调重写,来回改两三次,它就能抓住你想要的节奏。另外,我发现把句子长度限制在20个汉字以内,强制它拆短句,机翻感会弱很多。至于“像人类工程师”这种描述太抽象了,AI理解不了,你得给它具体的反面例子,比如“想象你在给同事发Slack消息解释这个接口,而不是在写论文”。最后建议你把自己以前写过的真实文档片段直接贴进prompt里当锚点,比任何形容词都管用。
给范例是真管用,我之前直接丢了一段Spring官方文档进去,让它照着那个语气写,出来的东西立刻就不飘了。另外你可以在prompt里加一句“用短句,每段不超过三行”,能有效治那个绕口病。还有个野路子是把“此外”“值得注意的是”这种词拉黑,写明“禁止使用这些过渡词”。