乐者为王

Do one thing, and do it well.

写出受欢迎的编程文章的10个技巧

英文原文:http://www.devx.com/blog/2009/01/10-tips-for-writing-consistent.html

对于作者,这是一个可悲的事实当谈到受大众欢迎时,不是所有的文章都是平等的,一些文章被证明比其它的更受欢迎。事实是,不管你选的主题有多好,或你写的有多好,你都无法每次都打出一个本垒打。尽管如此,如果你已经在写编程的文章(或者你正在考虑写),这里列出的技巧被证明能帮助文章从沉闷乏味的堆里跃升至最多查看次数的列表的顶部。

1. 选择一个简练的话题

挑选一个简练的话题是艰难的,因为很多有趣的话题一点也不简洁,它们是冗长的和复杂的。有时候你可以协同创建很好的、完备的、独特的文章作为一个较长的话题,但通常不要这样做。相反你可能需要写一个系列或一本书。要么选择别的,要么把这个话题分成简练的块。

接下来的几个技巧可以帮助你满足技巧#1的要求:

2. 增强现有的文档

一些最受欢迎的文章本质上是增强文档。那并没有什么错,因为技术文档经常是匆忙产生的,是不完整的,不是由开发者编写的,或缺乏相关的例子。在几乎所有情况下,文档(或文档的缺乏)给作者提供了丰富的话题。

3. 比较事物

另一个经常受欢迎的策略是写一个比较两个或多个受欢迎的项目。这些可能是语言,语言版本,APIs,数据库,操作系统,框架,编程方法,模式——在快速变化的开发者世界中,这里有无数的机会。挑两个或多个开发者使用的技术,并且写那种最好能帮助开发者转型或选择它们的文章。

4. 列个清单

你可能会认为它是厌烦的,但“10 for/about”类型的文章往往会做的很好。(如果这篇博文做的很好,我会认为它是这个观点的验证,如果没有的话,或许我会减少成“9个技巧……”)。编辑们和出版商们喜欢这些文章,因为读者喜欢它们。我怀疑读者喜欢它们是因为包含很多东西的文章增加了概率,这些文章至少有一个包含需要或至少有有趣的材料,但也许人们只是喜欢列表。无论如何……

在你有一个坚实的话题后,你准备开始写作,请记住这些点:

5. 忽视历史

是的,我知道你认为每个人在切入正题前都需要了解你的特定的主题的历史背景,但事实是,他们很少这样做。比起你在高中学习代数时想让你的父亲解释数学的历史,你的读者不再想沉思你的历史评论。这里有个读者行为分析的内部技巧:大部分读者从来没有读完过第一页。所以,如果你没有回答他们的问题,或立即抓住他们的兴趣,不管你文章的其余部分有多么正确,他们不会看它。链接到历史,切入正题。

6. 避免“HelloWorld”例子

你在你读过的文章和书里看到过一千个“HelloWorld”的代码例子,但这并不意味着它们是好的!它们不是。没有人喜欢它们。对于学习编程的任何事它们是完全无用的。它们也不是娱乐。完全有可能写出清晰而简单的既可以教又不烦闷的例子。

7. 说明你的观点

开发者喜欢代码,的确,但你也可以通过包含插图和截图帮他们节省时间和精力。这是因为他们中的许多人可能不会运行你那迷人的示例代码,但如果他们正在阅读你的文章,他们很可能对结果感兴趣。显示输入或输出无论何时都很重要。

8. 显示有趣的代码

许多技术作者似乎认为,提供一个简短的解释之后大量的示例代码(或者更糟的是,只是显示代码没有解释)将刺激他们的读者研究代码获得启示。我向你保证那不是真的。最好的文章解释了话题,只显示代码片断,然后解释或说明(或两者)代码做了什么,它如何与周围的代码或整体的话题适应,什么时候你该使用它,什么时候你不该使用它,也只有到那时——仅且当它是真正有用的——他们会向你打听更长的代码块。相反,只放有趣的代码在你的文章里,并提供其余部分为可运行的,完整的项目下载。

9. 化繁为简

避免冲动去告诉人们你的主题是多么复杂。他们知道它是复杂的,或者他们很可能不会读你的文章。相反,想办法去让你的复杂的主题显得更简单。

也许是所有中最重要的一点:

10. 简明扼要

最受欢迎的技术文章只给读者他们需要的——没有更多。

最后,这是真的,有些文章很受欢迎,尽管很少有或者没有在这里列出的特性——但这并不是你可以控制的东西。尝试去写那种文章很像博顺子,你会浪费大部分的时间。专注于基础知识,写很多文章,然后其中一些人将成为赢家。

快乐写作。

Comments