欢迎来到云闪世界。
“为什么我的经理对我的文章吹毛求疵?把措辞从 X 改为 Y 有什么区别?”
当你看到你的经理在你的文档中提出了无数建议时,你可能发现自己有这样的想法;我知道我有过。事实上,我曾经认为写作是数据科学家工作中最琐碎的部分;因为分析和数字应该不言自明,对吧?错了!
在过去的几年里,我意识到写作是数据科学家的一项必备技能,而良好的写作能力是高影响力的数据科学家与同行区别开来的关键因素之一。
在本文中,我将首先让您相信写作至少与您的技术技能一样重要,然后为您提供具体的建议以帮助您提高写作水平。
为什么写作对于数据科学家如此重要?
1. 它在企业界无处不在——我在之前的文章中强调过沟通的重要性,不管你喜不喜欢,企业界的大多数沟通都是以书面形式进行的。从项目范围文件到每周更新、分析和实验报告、反馈和绩效评估、JIRA 票证和 wiki 页面,一切都依赖于有效的书面沟通来传达信息。
2. 写作有助于理清你的思维过程——著名创业加速器 Y Combinator 的联合创始人保罗·格雷厄姆(Paul Graham,一位计算机科学家和作家)在他的一份备忘录中说道:
如果写下你的想法总能使它们更精确、更完整,那么没有写过文章的人就不会对某个主题有完整的想法。而从不写作的人对任何非平凡的事情都没有完整的想法。
— 保罗·格雷厄姆
很多时候,当你开始写下一些东西时,你会意识到你对某个主题的了解是多么的少,以及你的思维/分析中可能存在的差距。
3. 写作是数据科学工作的“最后一英里”。你的利益相关者都不会阅读你的 SQL 查询或查看你的 Jupyter Notebook(很多工程师和数据科学家都认为情况恰恰相反,但相信我,他们可能不会)。如果你希望你的工作被他人理解并影响决策,那么你需要完成最后一步,即以有效的写作方式进行包装。如果你跳过这一步,就像是把包裹留在仓库里而不是送到客户手中。
图片来自
数据科学中的“优秀”写作是什么样的?
明确你的读者。如果你为所有人写作,那么你就不是为任何人写作。明确这篇文章是为谁写的,并根据该读者及其需求进行量身定制。
关注“那又怎样”;香肠制作过程放在附录中。作为数据科学家,我们喜欢谈论我们所做的复杂分析或我们如何设计实验。因为我们付出了那么多努力,所以不谈论它感觉很浪费。但残酷的事实是,大多数时候,我们的观众并不关心;他们只是想了解要点。
您可以在附录中描述您工作的技术细节,以防有人想深入了解,但主要部分应该集中于见解和建议。
有清晰的故事情节。无论是否是小说,每篇(长篇)作品都应该是一个故事。因为这是人类交流的方式,也是我们的大脑处理信息的方式。通常分析的故事情节是这样的:
⮕ 我们发现了一些有趣的东西,这就是为什么你应该关心它/你应该做什么(摘要以吸引读者,包括适用的建议)
⮕ 以下是我们得出这些见解的过程(为好奇的探索者提供分析细节)
⮕ 以下是注意事项和替代路径(以防有人质疑建议)
⮕ 以下是您可能感兴趣的其他资源(附录适用于真正想深入了解该主题的人)
在添加细节之前先构建框架可能会有所帮助。如果故事取决于分析的进展情况(DS 分析通常如此,因为其性质更具探索性),至少在深入细节之前先弄清楚文档的结构。
如果你正在制作一个演示文稿,我有一点
有一个清晰的总结。如果你还记得我在上一篇关于沟通的文章中提到的金字塔原则,你就会知道它对于书面沟通尤其重要。因为总结是你与读者的第一个接触点,所以它应该足够有趣,以吸引他们的注意力,让他们想继续阅读;同时,它应该抓住所有的精髓,这样如果他们决定在总结之后停止阅读,他们就得到了他们需要知道的所有最重要的信息。
简洁明了。写作时,少即是多。
保持简单。我们从事技术领域的工作,一直使用技术术语。数据科学家通常认为,使用技术语言会让他们看起来更有能力。但如果你仔细观察,你会发现,越资深的人,他们选择的词语就越简单。副总裁和 C 级高管可以用任何人都能理解的语言解释复杂的话题,无论他们的(技术)背景如何。你可以使用Hemingway 应用程序等工具来检查你的写作是否过于复杂。
使用标记。标记是一种让读者更容易理解文档的技术。其核心思想是使用单词和短语来立即明确句子或章节的内容,以便读者可以快速浏览文本并理解它。例如:
- 在举例之前使用短语“例如”
- 在总结之前写“总之”
- 用“首先 / 其次 / 最后”来标记论证序列
始终把读者放在心上——读者最关心这篇分析的什么?读者对上下文/背景已经了解多少?他们还需要知道什么?
添加可视化。这句话之所以成为陈词滥调,是有原因的:“一张图片胜过千言万语。”当你试图传达密集的技术内容时,清晰的图表、框架或流程图可以帮助你表达你的观点。例如,像下面的图表一样说明“金字塔原理”的含义,希望能够让你更好地了解如何在自己的写作中实现它。
图片来自作者
你怎样才能提高你的写作水平?
多读书。这包括如何写好文章的指南(通过阅读这篇文章,您已经迈出了第一步!)以及您可以模仿的优秀技术写作(您可以在此处找到一些示例)。
如果你想深入了解写作的科学,我推荐你看看威廉·津瑟的《论写作》。
练习,练习,再练习。和其他所有事情一样,熟能生巧。以下是一些可以练习写作的具体方法:
- 在个人 wiki 中记录你的工作。根据我的经验,很少有数据科学家会这样做,但这是一种非常有用的资源,也是获得更多写作练习的好方法。
- 编写结构化的 Slack 消息。我们整天发送和接收的大多数 Slack 消息都像意识流(或者更糟,像青少年的短信)。人们倾向于输入他们想到的内容并点击“发送”,而不会花时间以易于读者理解的方式构建消息。使用上述原则编写简洁、结构化的 Slack 消息是脱颖而出的好方法。
- 在线写作。在 Medium 上写这些帖子对我来说是一种持续的写作练习。试试看;你甚至可能会喜欢它并找到喜欢你的见解的读者。
挑战自己。对于写作来说,“你是自己最大的敌人”可能不是坏事。你需要能够像第一次看到一样阅读自己的作品,这样你才能客观地了解哪些地方缺失、哪些地方令人困惑以及哪些地方需要缩短。
让别人成为你的反方代言人。有时候,成为自己的反方代言人可能非常困难,因为真正的客观性要求你放弃你对这个主题的现有知识和你的自尊。有时,为你的工作找到另一个挑战者会更容易。理想情况下,这个人真的对这个主题一无所知,并且愿意非常诚实地向你表达他们的观点。
有哪些优秀的技术写作范例?
我上面从理论上描述了好的写作是什么样子,但一旦你看到一些例子,就会更容易理解。这里我为上面提到的一些观点提供了一些具体的例子,这样你就可以更好地了解如何将这些建议付诸实践。
明确受众
数据驱动的 VC简报专门针对希望采用数据驱动方式投资和发展公司的风险投资家和初创公司创始人。虽然这会产生一个可能不会吸引所有人的小众博客,但选择这个特定的目标受众可以更轻松地为他们提供价值。
强大的可视化功能
有关如何将复杂系统和技术主题可视化的速成课程,请查看ByteByteGo。他们的图表使人们能够非常轻松地理解那些需要多段术语才能准确描述的内容。
SeattleDataGuy 也使用了大量可视化,但通常方式稍微不那么严肃(例如,请参阅此处的他关于 Apache Iceberg 的帖子)。
保持简单
《务实工程师》一书的作者 Gergely Orosz 很好地用相对简单的术语概括了复杂的主题。例如,查看他关于人工智能软件工程代理如何工作的帖子。
综上所述
写作能力(好)对于你的工作至关重要,甚至(或者,你可以说,尤其)对于技术人员来说也是如此。能够简洁地在纸上表达你的想法需要练习。多读书、多写、乐于接受反馈是提高这门手艺的关键。
感谢关注雲闪世界。(亚马逊aws和谷歌GCP服务协助解决云计算及产业相关解决方案)
订阅频道(https://t.me/awsgoogvps_Host)
TG交流群(t.me/awsgoogvpsHost)