如果你作为一名全职的自由内容作者,并在这个垂直领域已经深入了一段时间后,会总结出不少常见的错误,且多数新晋作者在他们的创作中也都大概率会犯。在这篇文章中,我整理了一个列表,列出了在写一篇技术文章时,需要牢记的七个要点。所以,准备好拿一张纸,拿一支笔,开始做笔记吧!
秘诀一:准备足够的时间来进行调研
作为一个作者,在形成任何主观意见之前,一定要遵循基于数据驱动研究的惯例。在技术领域,几乎所有人都同意“不同意”——即习惯于质疑。比如类似“从iOS与Android”,“从React到Angular”的问题——它们永远不会有任何明确的最终答案,也不会有任何明确的最终答案。所以,为了避免陷入“那个谁说了什么”导致的滑坡谬误,避免三人成虎,你需要基于事实来证实你的论点,而不是二手意见。这难道不酷么?
在写任何一个新的技术框架或库之前,作为一个作者,你的工作是首先要了解它当初为什么被创建?它的目的是什么?它在填补那些现阶段的空白? 这是必须要知道的,因为你不希望你的受众误用一个工具,把它应用在它不起作用的垂直领域。相信你明白这点。
秘诀二:永远先考虑整体架构布局
在你开始写任何一篇文章之前,你需要绝对清楚:即希望你的读者最终获取的核心信息。我总是这样强调:你应该能够用不到四个词来描述这个信息。你的信息是要教育(educate)、介绍(introduce)、推广(promote)、讨论(discuss)、辩论(debate)、比较(compare),还是其他什么?大多数的内容作品都不能向读者传递一个清晰的信息,因为作者自己都不清楚,文章的动机是什么。所以,先明确动机再写文章吧。
既然你头脑里已经有了明确的信息,接下来就要考虑构建你文章的叙述蓝图或讲述方式/结构了。现在你或许会问:“技术写作只是给出事实,对吗?我的意思是,我可以在一篇文章中构建什么样的叙事,来解释,比方说,冒泡排序呢?”
如果你带着这样的意图去写,那么你的读者有可能对你的文字没有那么投入。所以,你需要做的是:你需要把你的文章分解成三个简单的篇章。就这么简单,至少前期足够。
第一章:应该讨论文章的必要性:你认为的,不得不