• 工作空间

如何在没有技术背景的情况下编写有关编程语言的文章

  • Sara Illahi Panhwer
  • 5 min read
如何在没有技术背景的情况下编写有关编程语言的文章

介绍

写作一直是我的爱好。当我在一家教育科技公司找到一份 Web3 撰稿人的工作时,我的心情久久不能平静。根据《今日社交媒体》(Social Media Today)的统计,77%的互联网用户会阅读博客。因此,我的工作成为了一个向世界介绍我的作品的机会。

正当我做着白日梦,想着如何在未来几个月内拥有忠实读者和国际读者群时,我的经理要求我编写有关 Web3 领域大量使用的不同编程语言的指南。作为一个非技术出身的人,我觉得这是一项艰巨的任务。

不过,经过反复试验,我最终总结出了一套撰写各种编程语言长篇指南的秘诀,而且还是以技术背景人员的方式撰写。

因此,在这篇博客中,我将与大家分享五个小窍门,它们节省了我的精力和时间,帮助我撰写了技术性强、事实正确、能在谷歌上排名的指南。

Writing about programming languages without technical background (图片由 Metaschool 提供)

为什么要编写技术主题指南?

在本指南跳转到公式之前,让我们先了解一下为什么撰写技术主题指南很重要,而且能为您的博客带来良好的效果。

首先,技术指南是您与受众建立联系、分享知识和技能的绝佳方式。然而,技术内容也是非常小众的。如果你拥有的是一个生活方式博客,就不太可能撰写此类指南。不过,随着人工智能和区块链等新技术的发展,与技术相关的博客正在崛起。许多博客都有自己的人工智能支持产品。这就是技术写作在为您的博客和产品带来流量方面发挥巨大作用的地方。

遇见Ranktracker

有效SEO的一体化平台

每个成功的企业背后都有一个强大的SEO活动。但是,有无数的优化工具和技术可供选择,很难知道从哪里开始。好了,不要再害怕了,因为我已经得到了可以帮助的东西。介绍一下Ranktracker有效的SEO一体化平台

我们终于开放了Ranktracker的注册,完全免费!

创建一个免费账户

或使用您的证书登录

其次,毫无疑问,在当今时代,当你想学习一些技术知识时,YouTube 是你的首选之地。这里有成千上万的视频和教程。如果你愿意的话,这个空间已经相当饱和了。你现在可能会想,如果所需的材料已经可以在 YouTube 上找到,为什么还有人要撰写冗长的指南呢?答案就在这里。你周围的每个人或多或少都有同样的想法。人们专注于制作越来越多的视频内容,却没有意识到他们也可以通过撰写内容来积累受众。

第三,如果我们谈论编程语言,那么互联网上的书面指南并不多。官方网站上提供的文档往往字数较多,包含大量信息。指南的本质是整合语言冗长文档中提供的所有可用信息,对其进行总结,并分享一个不那么杂乱、易于浏览的版本,以迎合喜欢阅读的受众。

最后,重申一下,如果您的业务围绕技术、Web3 和人工智能展开,那么撰写指南是帮助您获得不同关键词排名并将您的业务推向前沿的最快捷方式。以上就是如果您的博客或业务与技术主题类似,您应该考虑撰写技术主题指南的部分原因。

窍门 1 - 明智地选择要编写指南的语言

第一步是明智地行事,因为您不会希望编写的语言(如 Solidity)指南已经很难获得排名。因此,在开始编写一门语言的指南之前,您应该首先进行全面的关键字研究。低难度关键词的神奇公式是:高搜索量和低难度。您可以利用 Ranktracker 的关键词搜索器来实现这一目标。您还可以查看已出版的完整指南的数量,以了解竞争对手的情况。事实上,为了衡量竞争对手,您可以使用 Ranktracker 的SERP 检查器,它将帮助您整合竞争对手的弱点。

不过,在选定主要和次要关键词之前,请确保您要撰写的语言没有过时或发生任何重大变化。有时,您可能最终找到了撰写语言指南的完美关键词,但却发现该语言的名称已发生变化,例如开罗现在是开罗 1.0。Ahrefs 等工具不会立即向您显示这一点。

如果一种语言已经进行了修改,您就会看到。但在某些情况下,一种语言可能仍处于提出更改的阶段。因此,对语言的下一步打算做大量的功课也是非常重要的。

提示 #2--指南大纲要非常具体

在撰写长篇语言指南时,提纲就是一切。然而,编写大纲也是一项艰巨的任务。在为广大读者编写指南时,有一条经验法则必须遵循:不能太基础,也不能太技术。您必须始终在两者之间取得平衡。

这就意味着,无论是程序员新手还是专家,都应该能够理解和掌握你所表达的观点。在这种情况下,你的提纲就能帮你大忙。现在,满足搜索者的意图并制作相应的内容同样重要。

遇见Ranktracker

有效SEO的一体化平台

每个成功的企业背后都有一个强大的SEO活动。但是,有无数的优化工具和技术可供选择,很难知道从哪里开始。好了,不要再害怕了,因为我已经得到了可以帮助的东西。介绍一下Ranktracker有效的SEO一体化平台

我们终于开放了Ranktracker的注册,完全免费!

创建一个免费账户

或使用您的证书登录

根据我的经验,当人们搜索语言指南时,他们通常是在寻找实用的知识。因此,你的提纲应更侧重于实践学习,而不是诸如编程语言历史之类的通用知识。

Be very specific about the guide outline (图片来自Sulekha)

提示 #3--从不难的内容开始引导

当您最终开始撰写语言指南时,请确保从最基本的内容开始,然后逐渐增加复杂性。如果您要写的是 Python 这样的语言,请从一开始就简明扼要地介绍它。记下有关该语言的所有重要和有趣的事实,并在开头中加以阐述。为了把读者吸引到博客中来,建议添加一些统计数据,如使用这种语言的人数比例等。您也可以将其视为回答一种语言的_谁、何时、_和_为什么。

然后,你必须提及一些使用这种特定编程语言编码的流行项目。在很多情况下,人们并不知道他们日常使用的应用程序部分或全部是用某种编程语言编写的。因此,这让他们感到好奇,并继续阅读下去。事实上,在指南中偶尔提及这些有趣的事实,会让经验不足的程序员更容易接受指南。

您还可以考虑将主要语言与其竞争对手进行比较。这将进一步为读者带来新的视角。总之,尽量用前 500-600 字来介绍语言。但尽量不要超出这个限度。

技巧 #4--充分关注指南的重点部分

如前所述,在网上查找书面指南的人是在寻找实用技巧和语言的具体内容。在阅读编程语言的文档时,你还会发现一个规律。有些东西在所有语言中都是不变的。其中包括数据类型、变量类型、框架、库、工具等。

由此可见,这些细节是不能妥协的,而且应该始终提及。虽然每种编程语言都有许多不同的框架、库和工具,但你应该做的是为每种语言选择 3 个流行元素并添加它们。在这方面,这些语言的官方 GitHub 账户可以为您提供很大的帮助。

遇见Ranktracker

有效SEO的一体化平台

每个成功的企业背后都有一个强大的SEO活动。但是,有无数的优化工具和技术可供选择,很难知道从哪里开始。好了,不要再害怕了,因为我已经得到了可以帮助的东西。介绍一下Ranktracker有效的SEO一体化平台

我们终于开放了Ranktracker的注册,完全免费!

创建一个免费账户

或使用您的证书登录

现在,你可能会问,既然 GitHub 上已经有了这些详细信息,为什么还要把它们添加到你的指南中呢?GitHub上的信息往往难以浏览,因为文件多达数百个。因此,将重点放在重要的部分将大有帮助,因为你将通过快速向读者提供前 3 个库、框架、工具等来填补空白。此外,读者还能从指南中获得最大收益。

秘诀 #5--加倍努力学习

当你开始撰写指南的主要部分(包括语言的具体内容)时,你应该确保通过实际应用你所写的内容来为读者提供价值。

如今,互联网上的大多数指南都不包括编码。你来自非技术背景,也不会意识到编码。但是,在文章中提及基本的编码步骤,尤其是使用您提到的框架、库和工具,可以使您的指南更有价值。

但是,如果你对此一无所知,又如何编写代码呢?这时,你可以从 Bard 或 ChatGPT 或 Ranktracker 的AI 文章撰写工具那里获得帮助,比如说,用 3 个简单步骤来编写最简单的智能合约。你可以让编码员朋友或熟人检查一下,或者把它发到编码员论坛上,以确保你写的东西是正确的。

这将增加你作为博客所有者或作家的真实性和权威性。

总之、

撰写冗长的技术指南并非易事,尤其是当你对编程术语知之甚少时。会遇到各种各样的挑战。不过,一旦你写了最初的 2-3 篇编程语言指南,你就会掌握其中的诀窍。这是一个过程。虽然上述技巧可能不是编写编程语言指南的最准确公式,但作为一个非技术背景的人,它们肯定能帮助你调整和增加指南的结构。

Sara Illahi Panhwer

Sara Illahi Panhwer

Writer at Metaschool

Sara Illahi Panhwer is a writer at Metaschool, a web3 ed-tech startup based in Singapore.

Link: Metaschool

开始使用Ranktracker...免费的!

找出阻碍你的网站排名的原因。

创建一个免费账户

或使用您的证书登录

Different views of Ranktracker app