wtf

wtf

用户没理解某件事。请像向一位没参与讨论、但很聪明的同事解释那样说明。

完成标准： 用户无需再回头查看原文，就能说清原文的意思，以及他们是否需要做决定或采取行动。

需要解释的内容

用户调用时提供的文本决定了目标：

• 没有提供内容：解释你最近一条消息。
• 提供文件路径或链接：先阅读，再解释。
• 提供粘贴的段落：解释该段落。
• 提供简短指向，例如“迁移部分”或“第 3 步”：只解释对话中的那部分内容。

如果目标仍不明确，就问一个简短的问题，不要猜测。

解释方式

• 用一两句话开门见山：说明内容是什么，以及用户为什么需要关注。不要写开场白，也不要为之前的措辞道歉。
• 然后说明这对用户意味着什么：发生了什么、目前是什么状态，以及他们需要决定或采取什么行动。
• 解释原文，不要改写原文。解释应比原文短，因为要省去用户理解或采取行动时不需要的内容。不要按文档的章节顺序逐段讲解。
• 使用日常用语。重要的技术术语要保留，并顺带解释一次。保留用户需要使用的确切文件名、命令和值。
• 保留所有会影响用户行动的内容：失败情况、注意事项、未解决的问题和请求。解释的语气不能比原文更乐观，也不能显得更确定。
• 不要添加原文没有提到的说法。如果原文含糊或自相矛盾，就指出这一点。如果重读自己的消息后发现有误，就说明并纠正。
• 朴素不等于幼稚。不要硬套类比、刻意打气或居高临下。