撰写更好的电子邮件（来自软件开发领域的示例）

电子邮件通信不是我最喜欢的，但由于我无法避免它，所以我尝试以一种我认为对我和收件人都更容易的方式来撰写消息：

• 快速解决正在沟通的问题
• 避免误解
• 节省时间

这里有一些提示。它们并不适用于所有类型的消息，我提供before一些after示例来更好地描述每种情况。

使用粗体/下划线字体强调文本

强调邮件的适当部分，尤其是当邮件很长时，可以帮助读者快速了解电子邮件的内容，并在将来某个时间点返回时轻松找到重要内容。

示例

前

大家好，

我注意到最近几天有很多 blabla 的日志，我
 我觉得这不正常。我认为问题出在更新的
宝石 blabla 的版本。

我在当前版本的 Redmine 中打开了一个描述该案例的问题（#455）。
如果出现问题，请随意更改其优先级。

谢谢，
拉撒路

后

大家好，
我注意到最近几天
有很多 blabla 的日志，
 我认为这不正常。我相信问题出在更新的
宝石 blabla 的版本。

我已经打开了一个 Redmine 问题（#455），描述了该案例
当前版本。
如果出现问题，请随意更改其优先级。

谢谢，
拉撒路

使用具体日期代替yesterday等tomorrow

电子邮件发送的时刻并不代表收件人阅读它的时刻
。避免仅使用时间副词/名词，例如yesterday，，，等，同时还要包含具体的 日期/时间，
today否则可能会造成误解，或者需要 收件人查看电子邮件的发送日期/时间才能计算实际 时间。tomorrowtwo hours ago

示例

前

尊敬的 QA：

昨天，我们在测试版中发布了针对 bug 455 的修复，我们计划
如果你在明天年底前给我们开绿灯，下周一发布
天。

谢谢，
拉撒路

后

尊敬的 QA：

昨天，2019 年 6 月 25 日，我们发布了针对该错误的修复程序
#455 已进入测试阶段，我们计划在下一步生产中发布它
星期一（2019 年 7 月 1 日）如果您在明天之前给我们开绿灯
（2019 年 6 月 27 日）一天结束。

谢谢，
拉撒路

使用链接作为参考

当您引用某些内容最终
需要收件人在另一个平台上搜索时，请使用可书签的链接。

这有两个好处：

• 节省时间
• 消除歧义引用

示例

前

亲爱的菲比，

我不明白关于日志记录问题所描述的过程
错误。Irida 的评论也不太清楚。你能帮我吗？

谢谢，
拉撒路

后

亲爱的菲比，

我不明白关于日志记录问题所描述的过程
Bug（Redmine #453）。Irida的评论也不太清楚。您能帮我看看吗？
请帮我？

谢谢，
拉撒路

构造长消息

长消息通常效果不佳，并且部分内容
容易被忽略。

当我必须撰写这样的消息时，我会尝试将文本分类到
上下文部分中，然后使用标题和
段落来构造它们，以便读者一眼就能找到它们。

示例

前

亲爱的团队，

上周，我们的生产环境的日志出现了问题。我
我正在讨论 Redmine 问题 #453。我们注意到
日志消息 blabla 导致响应延迟，因为 blah blah
等等。服务器磁盘耗尽，一切都崩溃了。
等等等等。管理员备份了日志并将其从
服务器发出啦啦啦的声音。我们开始调查发生了什么事。
两天后，我们成功重现了
暂存环境也是如此。问题在于使用外部
库里有个 bug，等等等等。我们移除了库，
该错误在临时环境中无法重现。
库里什么的都乱七八糟。我们昨天发布了修复，然后一切都
似乎已经恢复正常。我们还添加了一些脚本来通知我们
一旦出现这种情况，立即采取行动。

感谢您的时间，
拉撒路

后

亲爱的团队，

背景
上周，我们的生产环境的日志出现了问题。我们
 注意到日志消息 blabla 大幅增加。

结果
增长导致回复延迟，因为等等等等。在某些情况下
指向服务器磁盘耗尽并且一切都崩溃了等等等等。

问题原因
我们立即开始调查发生了什么事，两天后
我们也设法在暂存环境中重现了该错误。
问题在于使用了一个有 bug 的外部库，
等等等等。这个漏洞百出的图书馆就是等等等等。

采取的行动

1. 管理员备份了日志并将其删除
从服务器到 blah blah blah。
2. 我们删除了库，这个错误不再存在
在暂存环境中可重现。
3. 我们于昨天（2019 年 6 月 26 日）发布了修复程序。
4.我们还添加了一些会及时通知我们的脚本 
如果这种情况开始出现。

目前状态
服务器已启动并运行，一切似乎都恢复正常
普通的。

更多信息
相关 Redmine 问题 #453
外部库 - 官方错误报告

感谢您的时间，
拉撒路

具体说明你向谁请求什么

我见过很多很多这样的电子邮件：

• 发件人想从某人那里得到一些东西
• 收件人
  • 没想到他们会提供
  • 理解了发件人要求以外的内容

我尝试非常具体地提供我
需要的详细信息（如果可能），并且当有多个收件人时，我会
使用明确地引用每个收件人@。

示例

前

各位，

我已经提交了一个提交，可能修复了登录时的错误
准备阶段。我明天不在这里，所以你能审核一下并发布吗？

再见。

后

嘿，

我已经推送了一个提交
可能修复了该错误（Redmine#453） 
随着登录阶段的进行。

因为我明天（6 月 27 日）不在这里，你能
请：

@captain： 审查提交@qa 
： 运行套件进行验证
修复
@devs：继续进行生产版本发布
6 月 28 日获得 QA 团队的批准？

带来不便敬请谅解，
拉撒路

谢谢你，

拉撒路

附言

这篇文章最初发表在我的博客上。

附件中有一张我家猫的照片。