网络写作是一项技能,就像其他技能一样,只有通过实践才能完善。 我已经在此博客上写了两年了,在此之前为其他站点创建内容,我想我对此还可以,尽管总有方法可以改进! 在本文中,我将分享我多年来获得的一些智慧点,如果您开始写博客,或者甚至从写作转向印刷,这可能会对您有所帮助。
尽管这些内容是在考虑技术内容的情况下编写的,但它们可以应用于许多不同类型的Web内容。
新鲜写
雷切尔·安德鲁(Rachel Andrew)最近在推特上发布了以下建议,我完全同意:
最好的教程通常是由刚学过东西的人编写的。 很容易忘记盯着文档的感觉,想知道您是如何开始的,希望有人指导您完成文档。
-雷切尔·安德鲁(@rachelandrew) 2020年4月15日
毫无疑问,写这篇文章的经验会让您更加感兴趣。 这也意味着您可能会对该主题感到更加兴奋,从而使阅读更具吸引力。
我尝试遵循此建议,但并不总是成功!
不必担心拼写错误(太多)
您的读者将原谅您的拼写和语法错误,尤其是在内容有价值的情况下。 不要让不完善的语法使您无法发布。 但是,在检查代码示例时,请尝试更彻底-以我的经验,尝试从文章中尝试代码示例并想知道为什么它不起作用可能会令人沮丧。
另外,如果您不觉得自己是“自然”作家,也不必担心。 人们很少有判断力,可以回想一下您尚未完全找到自己的写作风格的事实。 您只能通过练习来提高自己的水平,所以不要让它让您失望。
切入点
读者希望尽快了解一篇文章是否与他们相关,因此值得投入时间。尝试在第一段中总结一下他们实际上将从本文中获得的收获。
用简短的段落写
网络与印刷品不同的一种方式是,很难吸引读者的注意力。 很多人在决定是否值得花时间阅读它们之前先对其进行扫描,并且文字墙看上去令人生畏,甚至在开始使用之前就将一些读者拒之门外。 简短的段落使此操作更容易。
为此,不同部分的相关标题也很方便。
说明您的条款
第一次使用新术语? 向读者解释你的意思? 使用首字母缩写词? 首先将其说明清楚-然后,通常就可以放心使用它了。
包含大量链接
在使用某些读者可能不熟悉的术语时,通常包含一个链接非常有用。 例如,我经常链接到CSS属性或规范的MDN(Mozilla开发人员网络)文档,尤其是在它相当新的情况下。 或者,如果我要提及其他开发人员的名字,我将提供指向其网站或Twitter简历的链接。
不仅如此,任何想深入探讨某个主题的人都将喜欢与您的资源以及可能会有所帮助的演示和网站的链接。 文章(或相关章节)底部的资源列表很方便。
(链接可能也对SEO有用。我对此没有任何实际数据,这也不是我包含它们的原因,但我被告知是这样。请不要只用链接填充您的文章但是出于SEO的目的,因为不相关的链接比帮助多了障碍。)
为读者而不是自我写信
这听起来似乎很明显,但有时在中流时很容易忘记。 我经常发现自己写的一句话听起来很雄辩,但在第二次阅读时,听起来对第一次接触该信息的人没有帮助。
使用大量的行话(尤其是没有说明)或复杂的语言(使用更简单的说明可以更好地完成工作),很容易使您的观众疏远。 在写书时,我经常问自己:“我写这句话是因为它很有帮助,还是因为它听起来很聪明?” 如果是后者,我将其删除。
承认你的缺点
没有人知道有关某个主题的所有信息(有一些例外!)。 您不必一定要成为专家就可以写一篇有用的文章-许多最有用的文章都是从初学者的角度出发的。 但是,请向您的读者说明您知识的局限性所在(并在可能的情况下包括指向其他来源的链接),以便他们可以就您的建议或方法做出明智的判断。
资源和致谢
这篇文章的灵感来自ManuelMatuzović的出色Twitter 帖子 ,随后他发表了一篇博客文章进行总结 。
比我聪明得多的人在技术写作方面写了更多的文章–他们还发布了非常成功的博客,因此请务必注意!
- Chris Coyier的技术写作建议 ,发布在CSS Tricks上
- 雷切尔·安德鲁(Rachel Andrew )在出版物上发表文章
- 只要写萨拉Soueidan