重写技术文档的5个提示技巧

有效的技术文档可以为用户节省无数小时的时间，并减少团队的支持开销。然而，大多数技术作家都面临着保持文档新鲜、一致且用户友好的挑战。语言模型（LLMs）可以帮助将现有的文档转换为更精致、更新的版本——如果你正确地提示它们的话。以下是五个LLM提示策略，可以帮助你重新组织、优化和增强你的技术内容。

1、零样本与少量样本提示

根据Tajinder Singh在Medium上的一篇有用的文章，零样本提示除了初始请求外没有添加任何上下文。它们简单直接，对于像语法检查这样的直接任务效果很好。然而，你可能需要更精确的输出。少量示例可以引导模型生成你期望的具体重写风格。例如：

零样本提示：

“以清晰且一致的语气重写以下技术文档内容。”

少量样本提示：

“这里有三个撰写良好的文档摘录。请确保我的新文本在清晰度、结构和主动语态方面与这些写作示例一致。现在重写以下文本……”

通过包含精心制作的示例，你可以引导模型产生一致的结果。

许多工具和帖子建议在重写的文档中指定你想要的风格。Document360的AI博客一篇文章强调了清晰和简洁的巨大差异。如果你想让你的文档更具用户友好性，让LLM知道：

"将此文档转换为轻松但有信息量的语气。定义要简明扼要，并在可能的情况下添加项目符号列表。"

明确请求某种特定的语气或风格可以帮助你的新草稿符合用户的期望。

SuperAnnotate最近的一篇博客文章告诉我们，逐步引导LLM可以产生更准确的输出。与其要求模型“彻底重写文档”，不如将其分解：

1. “识别此文档中的关键步骤和主题。”
2. “使用更简单的语言和标题起草修订后的提纲。”
3. “现在详细重写每个标题，保持连贯的叙述。”

这种链式思维方法确保模型首先关注结构，然后扩展相关细节。

当你的文档引用外部资源或大段代码时，仅仅告诉LLM“使这些文档更好”可能不够。你可以提供相关的文本或具体主题，采用“检索增强”的方法：

“下面是原始文档和相关的开发人员问答。结合两者来生成修订后的副本，澄清API的使用。包括重要的问答片段作为示例。”

这个概念是许多提示文章的热门话题，它允许LLM整合关键参考点。如果你想构建一个强大的知识库供LLM提取，你还可以使用协调平台统一你的来源。

销售和内容战略家Stewart Hillhouse建议让LLM提出初步的重写方法。例如：

首先询问AI：

“我需要一种更全面的重写方法。给我一个详细的LLM提示，另一个AI可以使用它来复制我文档的精致版本。”

然后审查它生成的提示，根据你的语气、布局或受众进行调整。

这种方法可以发现新的角度或改进，这些可能是最初未显而易见的。

当你完善你的提示策略——无论是通过细致的链式思维步骤还是通过展示几个样式示例——LLMs可以在重写最密集的技术手册方面表现出色。无论你是希望语气更友好，想统一外部来源的参考信息，还是希望确保清晰度，这五个提示都可以成为你的起点工具包。

汇智网翻译整理，转载请标明出处