技术写作:补充还是与生成型人工智能竞争?
ChatGPT,Bard,Bing,Midjourney和DALL-E - 这些都是现在的热词。随着每个惹眼的新生成型人工智能工具的出现,人们开始思考:计算机是否将夺走我们的工作?有些人认为Gen AI是一种革命性的,科技的火花。其他人则将其看作是潘多拉的盒子,一个迫在眉睫的危机,一个一切都发展过快的旋风。此外,越来越多的公司禁止在内部使用Gen AI工具,包括苹果,三星和亚马逊,这表明了网络安全风险,员工道德标准和合规挑战。
但是我们真的应该害怕吗?人工智能会如何影响IT专业人员?那我们技术写作人员呢?我们常常以能够用清晰易懂的语言传达复杂技术概念而自豪。随着能够创建新内容的基于人工智能的工具的出现,人们产生了一种潜在的担忧。这些工具能够复制人类作家为写作带来的微妙之处和理解吗?或者它们只能协助写作过程,帮助研究、内容组织,甚至是基本草稿的创建?让我们追溯到起源,更好地理解。
我们自己的研究
鉴于与时俱进的重要性,我们在SoftServe已经着手进行研究,探索Gen AI是否以及如何提高参与SDLC项目的IT专业人员的工作效率和质量。这包括软件和质量保证工程师、业务分析师、项目和产品经理,当然还有技术撰稿人😊
该研究方法围绕着探索特定任务以及人工智能助手在其执行过程中的方式和程度。
在我们的研究中,我们决定集中关注技术撰稿人每天执行的单独任务,而不是专注于庞大且耗时的任务。这样做使我们能够更容易地比较结果并评估通用人工智能的影响。
在考虑了许多任务后,我们选择了:
- 创建发布说明
- 基于用户故事创建一个主题
- 创建一篇新闻帖子
- 审核一段文字
为了轻松评估每个任务的成功,我们定义了一组精确可衡量的要求。这些要求作为共享的理解,确保所涉及的每个人都知道他们需要做什么以及什么构成了成功的结果。
例如,以下是根据用户故事创建主题的一些要求:
- 遵循Microsoft写作风格指南。
- 使用描述性标题来清楚地呈现该主题的内容。
- 新增了一些关于新功能的介绍句子。
- 逐步指导(7-10个步骤),并添加所需的详细程度。
在市场上有各种各样的Gen AI工具可供选择,我们选择使用最新版本的ChatGPT — GPT-4,因为它易于使用且快速上手。
特定任务然后分配给成熟水平相近的一对个体。每对个体中的一个使用人工智能执行任务,而另一个则不使用人工智能执行任务。执行使用人工智能的参与者被要求与ChatGPT进行对话,讨论与任务相关的问题,其中人工智能可以提供支持。
针对每个单独的任务,我们指派了一位专家,其职责是确保任务符合所有要求。他们然后评估了两组参与者的任务执行和结果质量,即有使用 Gen AI 的组和没有使用的组。不符合既定要求的结果被排除在最终计算之外。专家还观察参与者与人工智能的对话,并指出哪些提示表现良好,哪些不行。
结果
我们的研究清楚地展示了Gen AI在不同的技术写作任务中的表现。虽然在某些时刻有着较快的速度,但也存在明显的挑战。让我们深入探讨一下。
- 发布说明。我们观察到在制作发布说明时,生产力提升了35%。如果以更具营销风格创建发布说明,ChatGPT的效果更好。当生成详细介绍软件产品或服务的标准发布说明时,ChatGPT受益于明确的指导方针或您希望它遵循的示例句子。此时提示非常重要。
- 主题。在这里我们可以看到生产力增加了20%。由于ChatGPT的最后训练截止日期是2021年9月,它不知道已对文档指南进行的更改和更新,特别是我们所遵循的Microsoft写作风格指南。我们花了很多时间修复ChatGPT写的内容。因此,为了获得良好的结果,提示应该非常详细和信息丰富,列出您希望ChatGPT遵循的所有规则。这样,您将收到一个非常好的草稿,可用于您未来的主题。
- 帖子。ChatGPT 提高了 28% 的生产力,展示了其生成吸引人的社交媒体内容的能力。然而,一个关键的观察结果是,当 AI 配备了详尽的背景细节时,它才能发挥最佳性能。因此,虽然它有能力创建相关的帖子,但输出的质量直接取决于所提供信息的深度。否则,帖子会变得太普遍。我已经说过提示很重要了吗?😊
- 文档审查。在ChatGPT的协助下,文档审查过程的生产力提高了33%。然而,也存在一些挑战。ChatGPT没有突出显示所有的修改内容。此外,正如先前所述,它缺乏最新的技术写作指南信息。而且,ChatGPT无法审查大量内容,例如用户指南,因为它有1000个字符的提示限制。因此,在加快审查速度的同时,仍然需要认真的技术作家进行润色,以确保符合特定的样式指南。
对于人工智能是否会取代作家的结论,你可以自行判断 😉
深入研究并阅读《重新定义软件开发经济学》白皮书,了解我们的研究及其结果。
引发问题
在那些知道如何使用Gen AI的人手中,它可以自动化乏味的任务,释放出时间专注于更有创造力和复杂性的问题。在这种情况下,有效的提示至关重要。这节省时间,使交互更加顺利,并确保您获得所需的信息。
简单来说,一个好的问题会引导出一个好的答案。
下面是一个有效提示的示例,用于根据用户故事创建一个话题。它非常详细,并列出了ChatGPT需要遵循的规则。
嗨ChatGPT!
你是一名技术作家,我希望你创建一个主题,使用逐步说明描述基于我将提供给你的用户故事的应用程序的新功能。该主题应该有一个介绍句,描述新功能的好处,并包含7-10个使用该功能的步骤。
在你的写作中遵循 Microsoft 的写作风格指南原则。
- 使用简单的英语,因为主题需要为熟悉该应用程序但不熟悉技术术语的一般用户群写作。
- 使用第二人称“你”来直接与读者交流和引导,使指示更清晰易行。
- 使用命令语气和主动语态,保持HTML结构,将以下英文文本翻译为简体中文: "Please fill out the form and submit it to complete the process." 请填写表格并提交以完成流程。
- 避免使用特定于使用鼠标的动词“点击”。改用“选择”动词。
- 使用粗体格式化UI元素。
- 使用“对话框”而不是“弹出窗口”。
- 避免使用“选择”和“按下”这两个词。
- 使用“框”而不是“字段”来指代文本输入框。
下面是一个无效提示的示例,可能导致不满意的结果。该提示缺乏创造一个好主题所需的具体性和细节。它没有提供明确的指示和规则供参考。
嗨ChatGPT!
创建一个新功能的逐步说明
您是一位技术撰写人员,我希望您根据我提供的用户故事,创建一个包含逐步说明(7-10步骤)的主题,描述应用程序的新功能。
请遵循微软撰写风格指南的原则,保持清晰和一致。
下面是一些在处理提示时可能会有用的资源。
- 10个人工智能在技术沟通中的应用案例
- 超棒的ChatGPT提示
- ChatGPT提示的艺术
结论
技术写作在其核心上,比单纯地用纸张或屏幕上的文字创作更加微妙。它不仅仅是写作的行为所定义的,它涉及到多项任务的平衡。首先且最重要的是,它围绕着有效沟通展开。这不仅包括被动的文档撰写,还需要与开发人员、质量保证专业人员、产品所有者等多个利益相关者进行积极交互。
此外,了解用户的需求是这个角色的一个关键方面。这需要具备深刻的同理心和用户中心的思维方式。对反馈进行解读、提出正确的问题,并设身处地为用户着想,这些技能在这个领域中是不可低估的。虽然人工智能可能会在技术写作过程的某些方面提供帮助,但人的因素仍然不可替代。
但是,越来越多的人认为,擅长有效使用人工智能的专业人士将受到高度追捧。他们可以更高效地完成任务,这对雇主来说更有益。然而,对客户保密和信息安全的担忧仍然存在,因此要谨慎并遵循通用的安全规则很重要。请查看我同事的文章《技术文档中的ChatGPT:风险与危险》以获取更多细节。