小明的烦恼:代码高手,不爱写文档,老板让写调研报告,还好有 AI 帮忙
小明是一位前端工程师,写代码的能力在团队里首屈一指,但一到写文档就头疼不已。过去,他也曾被指派过类似“调研+写报告”的任务,每次都被老板挑出各种毛病。偏偏最近公司新上马了一个项目,要在网站上增加安全审计功能。后端团队已经做了一个初步技术方案,却完全忽略了前端如何与之对接。于是老板当场安排小明去调研一些常见的第三方统计/调查工具,看看能不能借鉴思路,并提出适合公司自身的前端集成方案。老板还给了他三天时间,要求他提交一份调研报告。
对于小明来说,三天时间并不紧,但他对文档创作的抗拒却让他倍感压力。所幸这一次,小明打算借助 AI 的力量来完成。
第一步:用 AI 做意图分析
从过去的教训出发
小明痛定思痛,他上一次任务之所以没做好,主要是没有正确理解老板的需求。那次他“自以为是”地去调研,结果方向完全跑偏,写出的报告与老板的预期大相径庭。这一次,他决定让 AI 帮忙先拆解一下老板的真实意图。
提炼会议记录
所幸,技术讨论会议是通过视频会议进行的,还自带录像功能,可以将会议录音转成文字稿。小明把老板对他下达任务的那部分对话摘取出来,贴给 ChatGPT,同时把会议主题和后端的技术方案文档的主要内容一起提供给它。
于是小明在 ChatGPT 中输入下面的提示词:
这是一次技术讨论会议,会议的主题是在网站上增加安全审计功能,这是技术方案文档 <技术方案文档> ...技术方案文档摘录... </技术方案文档> 下面是会议记录 <会议记录> ...会议记录摘录... </会议记录>
请帮我分析老板给小明安排的任务是什么?重点是什么?
提示词解读:
让 AI 去做任务,上下文一定要交代清楚,因为 AI 并不知道你参加了什么会议,老板说了什么话,所以要把会议的主题、会议记录、技术方案文档都交代清楚。
说清楚要让 AI 做什么事情,具体的任务指令要放在开头或者结尾效果最好,尽量不要把指令放在中间,可能会被忽略。
因为会话有长度限制,所以没必要把所有内容都放在提示词中,只需要把关键信息交代清楚即可。
借助 XML 标签,可以把提示词中的内容变成结构化的,这样 AI 不会混淆指令和背景信息。
AI 的分析结果
ChatGPT 很快就给出了要点:
调研第三方统计工具,重点考察安全、性能与可扩展性。 结合现有前端技术架构,提出可行的 UI 集成方案,比如如何收集数据、如何保证安全、如何兼顾性能。
看到这条分析后,小明暗自庆幸:幸亏提前让 AI 做了意图分析,否则他很可能只关注第三方工具,而忽略了前端自身架构的整合要求。
第二步:让 AI 帮忙生成一份“任务说明”
小明觉得,虽然 AI 给出了分析,但还需要和老板再确认一次,以免连 AI 也误解了什么。
于是在前面的会话中,小明继续写下了新的提示词:
请根据上面老板的要求,写一份任务说明,类似于 Agile 的用户故事(User Story),注意这只是一个分析类的任务,只需要生成一份分析报告
提示词解读:
像 ChatGPT 这样的工具,可以在一个会话中持续对话,所以可以接着前面的会话,继续让它生成,这样就不需要重新交代上下文了。
如果前面的会话内容和你要做的任务相关性不高,还是建议新开会话,把相关信息复制粘贴过去,因为不相关的内容太多会影响生成结果
输出格式上,可以参考一些业界标准的格式,比如 User Story 的格式,这样就不需要太多的去说明格式细节,也能让 AI 生成更符合预期的结果
ChatGPT 立即给出了一份简洁明了的 User Story。小明稍加修改后,把它提交到公司的内部任务管理系统,很快老板就回复“这就是我要的东西”。一场可能的“需求理解”事故就此化险为夷。
第三步:用 AI 辅助生成调研报告
在确定了任务范围后,小明计划把整个工作拆分为两个阶段:
调研现有的第三方统计工具并输出调研报告
调研当前前端技术架构,并提出如何与这些工具做无缝集成
(A)调研第三方统计工具
小明先打开 Chrome 的开发者工具,观察公司网站的所有网络请求,尤其留意那些来自第三方统计平台的请求。他列出了几个主要的请求 URL,以及它们所携带的参数和数据格式。
小明在新的会话中,输入了下面的提示词:
请帮我调研现在网站集成的第三方统计工具,重点分析其安全、性能和可扩展性,并给出详细的调研报告,下面是要调研的网络请求 <网络请求> ...网络请求1... </网络请求> <网络请求> ...网络请求2... </网络请求>
提示词解读:
这次小明没有使用之前的会话,而是重新开了一个新的会话,因为这个任务相对是独立的,和之前的会话相关性没有那么高,新开会话可以更好的让 AI 专注于当前任务,并且也不容易超出上下文窗口长度限制。
小明继续使用了 XML 标签,帮助把提示词中的内容变成结构化的。
ChatGPT 输出了一份详细的“第三方统计工具的调研报告”,GPT 对每一个第三方工具都列出了安全、性能和可扩展性的分析,并给出了详细的说明,最后还有一个汇总,提取了所有工具的共性,以及可以借鉴之处。
(B)调研前端技术架构
小明的网站中,已经有集成过类似的统计工具,但是这部分代码不是他写的,所以小明需要调研这部分代码,看看是如何集成的,然后根据这些信息,提出一个 UI 集成方案。
小明粗略的看了下代码,大概能明白代码的实现,但是他不知道该怎么去写成报告,于是他把几个相关的代码文件都摘录出来,然后去掉一些不相关的代码和注释,打开个新的 ChatGPT 会话,输入了下面的提示词:
<代码> ...代码摘录1... </代码> <代码> ...代码摘录2... </代码> 请帮我分析上面的代码,它的工作原理,如何我要集成一个类似的统计工具,需要做哪些改动?怎么保障安全性和性能?
提示词解读:
小明是新开会话和使用了 XML 标签,原因同上
小明直接把代码作为上下文,让 AI 帮助分析代码,但是为了防止上下文过长,所以只摘录了部分代码,去掉了不相关的代码,甚至有些代码只是保留了函数名、参数和返回值类型和注释
ChatGPT 给出的回答比较系统,包括:
模块化封装:现有代码是如何拆分成不同模块的,比如事件监听、数据采集、上报逻辑等。
安全控制:是否对数据做了加密或脱敏;是否有安全校验机制来防止前端脚本被篡改。
与前端框架的关联:如果网站采用 React/Vue 等框架,如何以组件化的方式封装或使用全局事件总线。
性能优化:脚本按需加载、批量上报、错误上报处理策略等。
整体来看,AI 的分析让小明对这部分老代码的结构和痛点有了更清晰的认识。
第四步:合并调研报告,完善最终成果
在完成“第三方统计工具调研”和“前端技术架构调研”后,小明就有了足够的材料去写最后的综合报告。他新开了一个 ChatGPT 会话,把以下三部分内容都贴了进去:
<任务说明> ...任务说明... </任务说明> <第三方统计工具的调研报告> ...第三方统计工具的调研报告... </第三方统计工具的调研报告> <前端技术架构的调研报告> ...前端技术架构的调研报告... </前端技术架构的调研报告>
我要完成一份网站集成第三方统计工具的调研报告,请根据任务说明、第三方统计工具的调研报告、前端技术架构的调研报告,生成一份完整的调研报告
提示词解读:
小明继续使用了新会话和 XML 标签,原因同上
小明把报告所需要的上下文都放在了提示词中,这样 AI 能清晰的知道报告的要求,以及报告所需要的内容
ChatGPT 很快就生成了一份条理清晰、结构完善的调研报告,从大方向到具体细节基本都涵盖到了。唯一的问题是,在输出时,有些地方的细节因为篇幅受限被 ChatGPT 自动简化了,这些是很有价值的信息,小明觉得没必要缩略。
因为现在 ChatGPT 这样的模型,一次无法生成太长的内容,很难把一些细节都保留的完整,所以还需要一些手动的调整比较好。
小明决定自己再做一次人工的“合并”,将原始报告中比较重要的分析和数据补充到最终文档里。经过简单的人工校对和排版,一份完整的、有理有据的调研报告就此诞生。
调研报告完成后,小明非常满意。一来,他掌握了更系统的分析思路,二来,原本以为要花三天时间的工作,现在竟然用不到两小时就做好了。
但现在小明纠结的是,老板让他3天之内完成,现在2小时就完成了,是该老实的跟老板说AI帮他完成了,还是剩下的时间偷偷摸鱼,等到最后一天再交上去?
你帮小明出出主意吧,他应该怎么做?