撰写有效技术文章的7个秘诀

在这篇文章中我们整理了一个列表,列出了在写一篇技术文章时,需要牢记的七个要点。所以,准备好拿一张纸,拿一支笔,开始做笔记吧!

秘诀一:准备足够的时间来进行调研

作为一个作者,在形成任何主观意见之前,一定要遵循基于数据驱动研究的惯例。在技术领域,几乎所有人都同意“不同意”——即习惯于质疑。比如类似“从iOS与Android”,“从React到Angular”的问题——它们永远不会有任何明确的最终答案,也不会有任何明确的最终答案。所以,为了避免陷入“那个谁说了什么”导致的滑坡谬误,避免三人成虎,你需要基于事实来证实你的论点,而不是二手意见。这难道不酷么?

在写任何一个新的技术框架或库之前,作为一个作者,你的工作是首先要了解它当初为什么被创建?它的目的是什么?它在填补那些现阶段的空白? 这是必须要知道的,因为你不希望你的受众误用一个工具,把它应用在它不起作用的垂直领域。相信你明白这点。

秘诀二:永远先考虑整体架构布局

在你开始写任何一篇文章之前,你需要绝对清楚:即希望你的读者最终获取的核心信息。我总是这样强调:你应该能够用不到四个词来描述这个信息。你的信息是要教育(educate)、介绍(introduce)、推广(promote)、讨论(discuss)、辩论(debate)、比较(compare),还是其他什么?大多数的内容作品都不能向读者传递一个清晰的信息,因为作者自己都不清楚,文章的动机是什么。所以,先明确动机再写文章吧。

既然你头脑里已经有了明确的信息,接下来就要考虑构建你文章的叙述蓝图或讲述方式/结构了。现在你或许会问:“技术写作只是给出事实,对吗?我的意思是,我可以在一篇文章中构建什么样的叙事,来解释,比方说,冒泡排序呢?”

如果你带着这样的意图去写,那么你的读者有可能对你的文字没有那么投入。所以,你需要做的是:你需要把你的文章分解成三个简单的篇章。就这么简单,至少前期足够。

第一章:应该讨论文章的必要性:你认为的,不得不写这个特定框架或这个特定算法的原因。让读者知道你为什么要投入这个话题,让读者自己也能理解它的重要性。

第二章:它应该有所有的内容。如,它应该有你的代码示例、逻辑推理、合理解释等:你想从这篇文章中传授的每一条有价值的信息都应该在第二章中。

第三章:该出结论了。这是你总结全部上述的部分,你要总结所有开放式的论点,并提供所有的参考资料,讨论未来的工作范围。你要总结所有开放式的论点,并提供所有的参考资料,讨论未来的工作范围(当然,如果有的话)。

你跟上我的思路了嘛?

秘诀三:真正了解你的目标受众

每当你写一篇文章时,你需要牢记你的目标受众是谁。你应该对这样的问题有明确的答案:什么是我的目标受众已经了解的信息?他们阅读这篇文章的动机是什么?你需要围绕目标受众的理解水平调整内容。给在校学生写的文章和给大学毕业生写的文章内容肯定不尽相同,这不难理解吧?你也要知道目标受众为什么正在读你的文章。例如,如果你写的是一篇谈论数据预测工具的文章,但这篇文章是为市场人士准备的,你就不会深入地写该工具用于预测的算法,而是强调它的偏前端功能特性。

同样地,如果你要写,比如说,在技术内容平台上写一篇数据结构的教程,你应该要假设阅读这篇文章的人会知道什么是编程语言,对吧?所以作为一个写手,你可以传授高度专业化的知识,只针对特定的人群。

秘诀四:专注提升内容地可读性

作为一个读者,告诉我,你更喜欢读一大段内容的文字,还是读用分列重点的内容?很明显,你更喜欢划重点地,应为这样的文章更容易消化和理解。你需要读者从你的作品中获得最大的知识。所以,把你的整个解释分解成重点、节、小节。让这整篇文章有条不紊。使用信息图表和插图,如表格、图表和图示,以清晰的方式解释复杂的主题。应该总像是在GitHub中写代码一样,尽量格式化地展现,而不能仅像普通文本展示一样。

另外,我始终相信:代码就像诗歌。总有有一个适当的格式来写它。在你的文章中加入这样的做法,你的受众会感谢你,相信我。

秘诀五:与官方资源进行核对事实和数据

毋庸置疑,在撰写技术文章时,你必须用官方(标准的、最初的、一手的)资源来验证所有提到的事实和数据,你也应该在文章中提供信息来源。事实上,如果你这样做,其实是非常值得鼓励的。此外,请一定记住,提供一个不准确的数据,还不如不提任何统计数据。所以,确保你所引用的来源是合法合理的。注意哪些,来自Quora或者类似的各类知识问答平台的答案可不能算作有效资源哦,它们可能是二手甚至偏颇的(有些甚至是刚编的故事)。

秘诀六:不要用非必要地夸张

一定不要这么做!千万不要这么做。你的文章要尽量短小精悍,它应该是容易理解的。过于啰嗦、或者拐弯抹角地展示你的熟练度或者专业词汇量会让你在技术社区没有粉丝的,(尽管这在某些其他类别的社区还挺普遍的)你知道吗?用一个当下时髦的词,叫凡尔赛,永远不要试图得瑟,优雅地得瑟也不要,因为其实很容易露馅。技术社区的写作有点类似科普,给予信息(inform)重于秀手艺(show)。要追求二刷,而不是三连。

你需要确保你的信息是清晰的,它是容易理解的,它需要不超过8分钟左右的阅读时间。任何超过8分钟的内容都会导致读者的留存率成倍下降。所以,如果你有达到一定字数的要求,请勿不必要地拉长你的内容——请直奔主题!而如果你的字数不足,那么可能需要考虑加入一个新的小节,或者尝试为作品增加更多的价值,而不是只写一些没有任何意义的文字。

秘诀七:务必记得校对文章

这可能是我能给你提供的最基本也是最重要的提示。如果作家在他们的文章中犯愚蠢语法错误的次数可以下降,他完全可能会比现在收获得更多。所以我强烈建议你使用相关的语法检测工具(如Grammerly等)来增加效益。

在发布之前,确保没有拼写错误、语法错误或格式错误。如果你在做一件事,就请一定要把它做好!

所以,小伙伴们,这就是写技术文章的七个快速有效的秘诀/技巧。希望大家能从本篇中获得一些收获。

本文来自腾讯云计算社区,转载请注明出处:https://computeinit.com/archives/2880

发表评论

登录后才能评论
交流群