技术写作过程:如何撰写一篇好的技术文章
#javascript #网络开发人员 #编程 #写作

在2021年,我加入了技术写作,在那里我写了接近20件付费技术文章,在线赚了6k美元以上。

根据我的经验,写一篇好的技术文章不是在公园里散步。一篇好的技术文章是一篇文章,将复杂的概念分解为简单易于理解的语言。

作为技术作家,要将复杂概念分解为一种简单易于理解的语言,您需要:

  • 首先,了解您正在写的主题。
  • 第二,了解您正在写的观众。
  • 第三,知道如何构建文章以将您的信息传递给读者。
  • 最后,知道如何在写作中使用正确的语音和语气。

要完成以上所有事情,您需要一个很好的技术写作过程。

在本文中,您将了解我用来为客户编写更好的技术文章的技术写作过程。

这是我要介绍的技术写作过程的步骤:

  • 步骤1:研究。
  • 步骤2:准备写作。
  • 步骤3:写第一稿。
  • 步骤4:评论。
  • 步骤5:编辑。
  • 步骤6:批准和出版。

步骤1:研究

首先,对您写的主题进行Google搜索,并查看与该主题相关的文章。当您查看文章时,请记笔记以更好地了解该主题。

另外,您可以询问changpt有关该主题的信息。然后将您从chatgpt获得的信息与从Google搜索获得的信息进行比较。

例如,我本周开始为客户技术文章撰写新主题。这是我在研究主题时记下的笔记。

Image description

注意:您需要将Chatgpt的信息与Google搜索的信息进行比较,因为ChatGpt有时会提供不准确的信息。

其次,确定您将要写的主题的格式和结构。

文章结构的类型

技术博客写作中有两种类型的技术文章。

  • 程序文章:这些文章逐步完成读者完成任务。
  • 概念文章:这些文章可帮助读者深入了解该主题并为进一步学习建立基础。

以下是文章的不同结构。

Image description

第三,确定您将要写的主题的目标受众。

确定目标受众的最简单方法是确定受众需要学习的内容。

写下目标受众在您将要写的技术文章中需要学习的所有内容的列表。

步骤2:准备写

首先,确定您要编写的文章的目标或目标。

在第一步中识别您的受众将帮助您确定文章的目标。

文章的目标可能是帮助读者学习或解决问题。

这是文章目标的示例。

Image description

其次,创建文章大纲。

简单地说,大纲是一本完整写作的骨骼,该曲目映射了您将在文章中介绍的主题。

大纲提供了一个结构,可确保您的想法在逻辑上清晰地流动。

确定第一步中的文章格式和结构将帮助您创建文章概述。

例如,这是我为dbvisualizer博客写的文章的概述。

Image description

注意:确定文章的目标并创建大纲后,如果是客户的工作,则可以将文章发送给客户以获取反馈以确保您在同一页面上。

步骤3:写第一稿

首先,将文章的目标包括在标题中。以下是标签格式的方式,

标题格式

如何使用<软件或技术>

例子

如何使用JavaScript创建计算器

其次,开始编写文章简介。每篇文章的介绍都应有1到3段。

良好介绍的问题应该回答

  • 问题是什么?
  • 解决这个问题的方法是什么?
  • 读者将学到什么?

第三,写前提条件。先决条件的目的是在读者遵循当前教程之前应有或要做什么。

格式是读者可以用作清单的列表。每个点必须链接到涵盖必要内容或官方软件文档的现有教程。

这使您可以依靠已知的现有内容而不是从头开始。

第四,开始以步骤编写文章主体。步骤是您文章的一部分,您可以描述读者需要做什么以及原因。

一个步骤包含命令,代码列表和文件,解释了该怎么做为什么要这样做。

最后,写出文章的结论。本文的结论应总结读者通过遵循您的教程所学到或完成的内容。

步骤4:初稿评论

撰写了初稿后,将其发送给客户,主题专家或对您正在写的主题的知识的人。

让客户或主题专家审查草案,确保文章在技术上是准确的,并符合文章的目标。

步骤5:编辑和修改

编辑和修订是您将审查草案塑造成最终草案的地方。确保您在写作和编辑之间休息一下。休息一下将使您能够用新鲜的眼睛查看您的作品。

您可以在编辑过程中使用语法等工具来检查拼写,语法,样式和标点符号错误。

步骤6:最终草案的校对和批准

校对最终草案是在您完成写作时,但尚未准备好发布或将其交给客户批准。

在这里您浏览您的文章:

  • 任何拼写错误
  • 语法错误
  • 错别字
  • 格式错误
  • 不正确的结构或语法

校对最终草案后,将其发送给客户进行最后审查和批准。

步骤7:发布完成的文章

如果不再对最终草案进行更改,则客户将发布文章。如果是个人文章,您可以在博客或免费的博客平台上发布它:

  • 中等
  • 开发到
  • hashnode

结论

您已经学会了如何在本文中逐步撰写一篇好的技术文章。如果您喜欢这篇文章,请在Twitter上关注我以获取有关技术写作的每日技巧。

https://twitter.com/The_GreatBonnie