撰写博客和文章

点击查看目录

image

网络写作是一项专业技能。很多时候,你会发现人们在写在线文章或博客文章时运用其他媒体的规则。成功率很低。

请注意,网络上的文本不是孤零零的在某一个地方发布的,而是以书签、链接和参考文献的形式在整个网络上传播。因此,重要的是将文本分成易于消化、可引用和可重复的几块,并使你的文章标题和文件标题在没有全文的情况下也能发挥作用。

事实:这也是一个无障碍的好处。像屏幕阅读器这样的辅助技术允许你按标题浏览文件,而不是把整个文件当作一大块来听。

简单并不愚蠢

写简单的文本是艰苦的工作。写出令人印象深刻的文章则比较容易。你经常看到人们试图通过使用复杂的词语和参考资料来打动观众。当你写小说或歌词时,这很好,在玩弄语言时有很多乐趣。然而,在网络上,尤其是在开发人员布道方面,你的目标应该是尽可能地让人理解。请考虑以下简单文本的特征:

  • 用简单的术语写作需要大量的工作和对主题的彻底理解。你需要熟悉这个主题,才能用简单的语言解释它。如果你不能用简单的语言解释,很可能你自己还没有完全掌握这个主题。
  • 如果用尽可能简单的术语解释事情,就能确自己保接触到最可能多的读者。
  • 简单的措辞让非母语人士有机会了解整个事情的内容,也许还可以花些时间使用翻译工具,使之对他们有用。
  • 简短、容易掌握的句子读起来不那么累人。当你看第一眼时,它们也不会让人感到畏惧。在阅读文本之前扫描文本是网络上非常常见的模式——特别是在移动设备上。

警告:然而,在用简单的术语解释复杂的事情和听起来居高临下之间有一条界限。如果你怀疑自己在"简单化"的道路上走得太远,可以让别人看一下你的文章以避免这个问题。阅读和重读你所写的东西(中间休息一下),并使它在每一次反复中变得更容易。

与现实生活中的物体和场景进行比较,可以很好地简化复杂的问题。

例子:在雅虎工作的 “黑客开放日”,我和几个媒体人谈过,他们对黑客日和开放 API 的概念感到非常困惑。那时,这些都是全新的东西。我是这样解释的。“如果雅虎是一家汽车公司,我们最新的车型会在这里被拆解,我们会允许人们玩弄这些零件。也许他们会找到一种很酷的新方法来组装它们,这就是我们想要的使汽车更环保、更高效的突破。”

提示:我在网上写作时经常使用的一个工具是海明威。你可以到 hemingwayapp.com 试用它。它是一个在线编辑器,给你一个指标,说明你的文本需要什么阅读年龄。它标记出常见的问题,如句子太长或过于复杂的单词。

简单直接——不要用糖衣包裹

你的标题和介绍性文字是一个博客最重要的部分。两者都决定了将来找到这个帖子的难易程度。报纸已经使我们有条件写出诙谐有趣的标题,其中包括流行语和典故。这很有趣,但你读了它们,说明已经买了报纸。网络标题会变成链接、书签和社交媒体分享。因此,它们需要在没有其他文字的情况下有意义。对于一篇技术性的博客文章,要说明文章的内容——不要试图变得太聪明。流行的参考资料甚至更糟糕,因为这些资料并不能很好地转化为其他文化。问问自己:你是想在一分钟内表现出创造性和诙谐,还是想在几个月内提供有效的信息?

博客文章应该像广播中的新闻项目一样:

  • 在任何博客的开头,都要说明发生了什么,在哪里发生,如何发生。
  • 继续解释博客中的内容。
  • 然后进入细节。

这将防止任何混淆,并让感兴趣的人去了解更多。当在社交媒体和任何地方分享时,人们以自动方式链接到你的文件,他们将可能使用博客的标题——无论是 HTML 中的标题还是文件的大标题。如果你的标题脱离上下文,显得没有意义,就不会有很多人点击它们。

提示:大多数社交网络都有链接预览,可以自动将链接扩展到其标题和第一张图片。这一点很重要,也是一个可以利用的强大的东西。熟悉你的文章中需要的元标签,以便在你选择的社交媒体平台上获得一个合理的和令人兴奋的预览。

内容长度

在线使用的技术写作是指保持简短和直接的内容。人们很忙,想要了解事实。

提示:为了写出好的文章,要写,要读,要删除不需要的东西,要再读,要删除更多的东西,如此反复。如果你不能再删除了,你就达到了发表的目的。

如果你有很多内容要讲,为什么不把它分成几篇?这将使你能够在第一篇文章的结尾处预告下一篇文章将在几天后发表,并使你的博客有重复访问者。

添加多媒体内容

如果可以,在博客中加入相关的媒体。一张介绍性的照片可以吸引人的眼球,并引诱大脑阅读所发生的事情。我们很幸运,现在嵌入视频、音频和幻灯片就像复制粘贴一样容易。

嵌入多媒体将我们的信息捆绑在一起,易于消化。它还允许访问者在第一时间浏览文章,并在稍后回来阅读其他内容(观看视频、下载播客)。它还可以帮助那些很难阅读但很有能力听或看的人。

在嵌入多媒体时,确保也要写上说明性的文字——图片需要有好的替代文字,视频至少要有对它们所显示内容的描述。

提示:通过提供文本替代物或你的笔记,幻灯片的效果会好很多。许多幻灯片托管平台会自动为你的幻灯片创建一个 HTML 脚本。就我个人而言,我从我的笔记开始,然后根据这些笔记创建我的幻灯片——这样,我总是有一个 HTML 版本可以从幻灯片中链接到。

结构化内容

构建你的内容是非常重要的。给读者提供地标,让他们在决定阅读你的信息之前先浏览一下文章结构,由于人们很忙,这一点非常好。

你通过使用分层的标题结构来实现这一点。这也将有助于使用屏幕阅读器等辅助技术的人快速地从一个部分跳到另一个部分。如果你在标题中加入 ID,人们就可以将文件的某些部分作为书签,并将链接发送给朋友,使他们直接到达他们想去的地方。

提示:从你的标题大纲开始,你写文章的速度会快很多。你甚至可以在不同时间写文章的不同部分。通常情况下,当我被文章的某一部分卡住,面临一些写作障碍时,我会暂时跳过它,写其他更容易或更熟悉的部分。

结构化的文章也意味着使用短句子。它意味着一次处理一件事的段落。它意味着使用列表来解释一步一步的过程,或对现有的内容进行概述。对于大型文件,它还意味着提供一个目录,使人们能够直接跳到他们需要的地方。

给你的内容打上时间戳

如果你吃的食物超过了"最佳食用日期",你就会生病。如果你不给你的出版物打上时间戳,它们将被认为是永远正确——即使按照未来的技术标准它们是有害的。它们会被引用——有时是糟糕的引用,并被反复引用,被当作真理。

例子:当我开始做网站开发的时候,用于布局的表格是建立网站的唯一方法。你必须知道很多技巧才能使这些表格在 Netscape3 和 IE4 以及其他"有趣"的浏览器上工作。我发表过几篇关于如何做到这一点的文章。现在,表格布局对网页开发来说是适得其反的,而且实际上渲染速度更慢。如果我的文章上没有日期,也许人们还会认为它们有意义。所有的"CSS 布局太难了 “的文章肯定暗示了这一点。

我们的技术环境以极快的速度发展。半年前的 “最佳实践 “现在很可能被认为是"有害的”。因此,让我们确保读者在遵循某份文件的建议之前,即使现在也要知道它是什么时候写的。

引证以证明

本节的另一个要点是引用其他来源并链接到你所建立的内容。通过引用其他来源(当然是在阅读之后),验证了你的想法和事实。读者不必盲目地相信你——他们可以通过比较来明确自己的想法。

先发制人

请记住,作为开发者布道师,你是技术人员和外部世界以及技术人员和你自己公司之间的缺失环节。这给了你一个其他公司部门做宣传时无法完成的任务,我称之为先发制人的写作

我的意思是,当你谈论产品的时候,你不应该 “推销"它们。相反,你的工作是让开发者对它们感兴趣,让他们成为你的销售人员。这方面的主要任务是预测如果你做一个普通的销售推销会得到的反馈,并在反馈发生之前回答它——先发制人的写作。

不要试图用糖衣炮弹或隐藏负面信息:而是解释为什么会发生,发生时该怎么做,以及如何向负责解决该问题的人报告。

事实是:作为开发者,我们是一群愤世嫉俗的人,多年来被打破的承诺使我们变得坚韧。对任何产品的过度兴奋和积极的描述都不会让我们认为"我必须得到一些这样的产品”,而更有可能引发"好吧,有什么好处"的疑问。

这使得开发者看起来不善于交际,对于一个市场营销或公关人员来说,如果做了一个经典的推销,却面临着一连串的负面反馈,这可能是令人难以置信的沮丧。你的工作是预测这种反馈的一部分,并通过在你的文章中承认它来解除这种情况。这对你的公关和营销部门来说可能是一个难点,但你可以这样向他们解释:通过公开好的和坏的,你可以避免很多混乱的或不好的反馈,这些反馈会被媒体断章取义,给公关部门带来很多工作。

提示:最近,公关部门也开始采用先发制人的写作理念。我一直看到的一个过程是为即将发布的新产品创建一个"无礼的问答”。该产品的团队创建了一个故意粗鲁和有问题的问题清单,并举办一个研讨会,讨论如何处理这些问题。如果这些问题在真正的发布时没有出现,那么很好。然而,如果它们真的出现了,你就有了准备。

负面的反馈在很多情况下分为几类,所有这些通常都是以"互联网巨头"的方式来展示作者。

事实是:虽然有些人是巨魔,喜欢用负面的反馈来制造麻烦或"对抗系统”,或试图哄骗人们不必要地延长讨论,但其他人却因为一次次的失望而不由自主地这样做。这是一个很难保持的平衡。真正的巨魔应该被简单地忽略,或者像俗话说的那样"不要喂巨魔"。但人们可能因为发帖太快或愤怒而成为一个"意外的巨魔"。无视负面反馈可能是很诱人的,但有时措辞暗示了另一个问题,你可以而且应该解决。

这里有几类负面反馈和预先避免它们的技巧:

  • 这对我来说根本不起作用:确保以必要的细节来定义运行你所谈论的产品或演示所需的环境。
  • 这与 Y 公司的产品 X 一样:很多时候这是个竞争对手的粉丝。提到你的产品与其他产品非常相似,并列出它们。详细解释两者的不同之处,并说明你的产品不仅仅是一个副本。通过展示你对其他产品的了解,你证明你确实做了功课,并且仍然认为值得谈论它。不要让人们发现你没有做研究。
  • 很好,但我永远也用不到,没有人需要它:详细解释该产品解决了什么问题。如果这不是一个现在常见的问题,而是未来的一个问题,则要求反馈人们如何喜欢这个产品。同时告诉他们,这是一个机会,以确保一旦他们遇到这个问题,产品就会准备好,而且很好。
  • 当你的产品 Y 仍然是坏的时候,你为什么要在这上面浪费时间?: 确保你的写作设定了文章的范围。详细地谈论一个产品。如果你很幸运,其他人会回答这样的评论,并指出它是不合适的。如果不是,迅速回答说它是,并指出一个不同的主题或讨论,在那里该人可以发泄他们对其他产品的不愉快。
  • 我喜欢这一点,但我没有时间来测试:准备一些带有简单反馈机制的演示和代码例子,让人们通过简单的点击来尝试,甚至可能提供一个简单的调查。

这些只是几个例子,说明可以利用全面披露来预先避免不良反馈。还有很多,但我相信你会找到处理这个问题的好方法。好好看看你写的材料,试着在坏的反馈发生之前预测它。你通过提供更清晰的信息所能避免的任何误解都可能是另一个快乐的客户。

行动呼吁及更多信息

当你完成了你的文章,用行动呼吁来结束是有意义的。你应该重复使用的资源,在哪里可以找到更多,以及如何联系你或你所写的产品的团队。

最后更新于 2024/05/17