技术文章写作技巧:给程序员的建议
作为一名程序员,你或许会觉得写文章没有必要。但事实上,你的编程水平越高,就越需要你分享你的最佳实践、成就和建议,让更多人了解你的想法。本文将为你揭示写作的理由、写作步骤以及如何写出高质量的文章。
为什么要写文章?
你有没有搜索过自己的名字?
与专家建立联系是一种很好的做法。当人们在网上阅读你的文章时,他们会把你视为专业人士,并更加信任你。
那么,为什么要写作呢?
- 宣传。
- 自我宣传,打造个人作品集。
- 它有利于提升公司的声誉(如果你在公司工作的话)。
- 简单的知识分享。
主题
请描述一下您的经历……
与工作相关的经历。
如果你是一名 PHP 开发者,没人会指望你写关于 Elixir 的文章。不过,你可以分享一下你学习 Elixir 的历程或心得体会。
另一方面,作为一名开发者,你也可以分享你的个人观点或日常工作中的一些心得体会。如今,很多人都对开发者的个人动机、技巧和方法很感兴趣。
研究
检查是否有人之前写过相同主题的文章。如果有,除非你有以下情况,否则无需创建另一篇相关文章:
- 更新(新)版本
- 有争议的(你不同意前面的观点)版本
- 细节
不要写和别人写过的东西一样的东西。
尽可能多地查找相关资料,进行研究和比较。
命名
研究之后,你应该想出一个独特而清晰的名称,能够表明文章的目的和背景。
反例:
- 第 58 期综述:Orleans 3.0、Snitch、What's Your Problem?ASP.NET Core 未来五年展望
- 统领所有编程语言
- 是否正遭受技术债务的困扰?
为什么我认为这些例子不好?第一个例子太长,关键词太多,反而不够具体。另外两个例子根本没让人明白材料到底讲的是什么。
好例子:
- 使用看门狗定时器确保 Node.js 程序健康运行
- Angular 中的自适应组件和父级驱动行为
- 如何在 React 中发送 HTTP 请求
名称应该更具体,但不要太长。从我列举的这些“好”的例子来看,你可以突出每篇文章的主要关键词和目的,同时它们又不冗长。
文章结构
虽然内容组织方式多种多样,但用户通常期望文本以某种特定方式呈现。以下是一些文章结构标准,您可以遵循这些标准来吸引用户并以最相关的方式呈现信息:
- 标题
- 抽象的
- 介绍
- 主体:代码、示例、图片
- 结论/总结
- 未来工作/参考文献
最后一部分通常是帮助你将你的材料与博客或出版物中呈现的其他文本联系起来。
代码片段和图片
与主题相关的优质图片越多越好。
如果文章与代码相关,请插入一些代码片段。可以使用 CodePen 或类似的网站。
标签和关键词
关键词至关重要,因为搜索引擎可以通过关键词将访客引导至您的网页。
如果您要撰写有关 React.js 的文章,则应添加以下标签:ReactJS、JavaScript、编程、软件开发、Web 开发、Web、UI、开源(例如)。
要查找合适的关键词,您可以使用几种可用的在线工具。
想在文章中加入关键词,请尝试:
- moz.com
- app.neilpatel.com
- trends.google.com
- keywordtool.io
- wordtracker.com/scout
将最相关的内容放在文本中。
标签对于将您的内容与其他同主题内容关联起来至关重要。
至少使用 5 个标签来表示技术、产品、方法、经验等等。
语言和语法
人无完人。当你灵感迸发时,写作过程中难免会出现一些拼写错误。而这已经是最好的情况了。为了让你的文字和句子正确易读:
- 仔细检查每一句话。
- 如果您不是以英语为母语的人(我指的是英语),如果您对句子的意思有疑问,请自行翻译。
- 使用 Grammarly(或其他类似的旨在纠正文本的插件)。
- 请务必使用正确的术语和短语。
此外,你可能会使用习语,但要了解其正确的用法。
专业提示
- 请使用现在时。(这意味着您目前正在使用您所描述技术/方法/途径。)过去时也可以,但仅限于描述特定经验的情况。
- 避免使用冗长、复杂的段落。
- 首次使用时,请展开所有缩写词。
- 提供数据(数字、事实)时,务必提供信息来源。
示例
在这里,我会分享一些我觉得值得关注和借鉴的文章。
跟随他们
这些人代表他们的项目和公司,他们是每天撰写文本的工程师:
https://dev.to/ben — Ben Halpern, http://dev.to的创建者/创始人/网站管理员
https://overreacted.io/ — Dan Abramov,Facebook 软件工程师
https://twitter.com/John_Papa — 微软开发者,https://johnpapa.net/
https://twitter.com/linclark — 来自 Mozilla 的 Lin Clark
https://twitter.com/addyosmani — Addy Osmani,谷歌工程经理
我希望这些内容能带你进入写作的世界!
感谢阅读!