一篇技术文章合格的标准

10

原文地址

前言

作为一个开发者,经常需要在网上查找各种资料,但是一个让人倍受打击的事实是,现在网上的大多数文章质量都太糟糕。行文混乱,观点不清,结构失调,甚至有些都不能算是一篇真正的文章。作为一个有正确价值观的人,我觉得应该自己建立一个博客,写一些质量相对较高的文章(当然是自认为)来提升国内互联网内容的质量。理所当然,任何人都有对这些文章中观点怀疑和评论的权利,我也很愿意针对自己认为有意义的评论进行讨论。

笔者认为一篇合格的文章应该遵循以下原则。

非转载

没有任何修改,直接粘贴复制别人的文章到自己的博客。这种行为唯一产生的意义就是浪费了互联网上大量的硬盘空间。这种东西(是的,它们不能称之为文章)没有任何新的知识和观点,不会对互联网做出丝毫建设性的贡献。

有些人会说,我将这些文章放到我的博客,可以记录自己的学习轨迹,对自己是一个激励,并且我可以随时参考这些文章。如果是这样,那么你应该认识到一点,绝大多数的网站都有收藏功能,即便没有,你也能够很容易的找到类似pocket的网络资源收藏工具。

根据非转载原则,笔者认为,csdn博客撰写页面上的那个原创和转载选项是一个充满负能量、毫无正面意义的垃圾功能。网络上的任何资源都应该是原创的。

结构完整

任何一篇文章都应该拥有完整的结构。诗、词作为文学作品中最精简的体裁,也会包括起、承、转、合的简约架构。体量比诗词更大的文章(普通技术文章、散文、杂文、论文)更需要良好的结构来支撑。没有一个说的过去的结构,文章就很难站起来,就是一盘散沙,没有精神。这样的文章看起来没有任何节奏,对读者来说是一种耐心的挑战。

一篇文章的结构最低的要求是完整。尤其是技术文章,结构并不要求精巧,但是必须是完整的。你可以写地详细也可以写地笼统,但是不能写的不完整。

观点或主题

观点是写文章的动机,一篇文章不可能没有观点就直接写出来。对于技术文章来说,观点可能就是一个具体的知识点。但是,一旦主题确定,文章中任何内容都必须为主题服务。避免不必要的、和主题无关的内容出现在文章中是明智的选择。并且,文章中的所有段落都应该为主题进行合理的安排。

案例

对于说明观点来说,举例是很好的方式,好的文章应该尽量包含合理、贴切的案例。记得早些时候看过钱钟书先生的一些文章,比如《围城》《写在人生的边上》,文章中的比喻用的恰到好处,为观点进行了简单、巧妙的诠释。甚至连“写在人生的边”上这个标题都是一个绝妙的比拟。当然,比喻是最简单的案例。对于技术文章来说,有时候,一个简洁恰当的案例,要比大篇幅的解释还要更加深入人心和更容易使人理解。

参考

写文章之前多参考一些资料,是一个好的习惯。如果文章写完,末尾没有参考资料或者资源引用的链接,那要么是你版权意识不够,要么是你没有意识到参考资源对读者的作用有多大,当然,还有一个最不应该的可能,就是你根本就没有参考其他资源。对于同一个观点,不同的人有不同的思考角度和思维方式,辩证和批判性思维是全面、深入理解一个问题有利的工具。

排版

排版是开发者必备的基础能力之一。没有基础的排版能力,是无法写出阅读性良好的文档的。文档算是最简单的文章,连文档的排版都不会,那么请自学word排版知识,再来写文章。一个版面杂乱的文章是会倒读者胃口的。

你可能感兴趣的

n͛i͛g͛h͛t͛i͛r͛e͛ · 2014-09-29

但愿有用

回复

Marker · 2014-10-20

第一点就表示不赞同!一篇好的文章不转载到自己的博客里。,。难道要保存书签吗?记录本地文档吗?转载有些时候只是为了一种记录

回复

alert_null · 2014-10-22

说的不错

回复

yanwushu 作者 · 2014-10-22

第一,转载是要操作成本的,至少是复制和粘贴,这和保存在本地在操作上没有区别,而使用专业的网络搜藏工具(比如pocket,印象笔记)操作成本就会很低。而且日后查看起来会高效和方便的多(分类、标签),并且,你以为这些成熟的收藏工具是为谁、提供 什么服务的??
第二,转载文章,会造成网络资源很大程度上的重复和冗余,请考虑下别人的感受(当你在网上搜索文章,一个关键词,搜出的都是同一篇文章的不同拷贝,而且还找不出原版文章的地址)。

回复

风起 · 2014-12-09

这个看个人了, 别墙传播理论, 应该还多和我一样不喜欢资料分散, 其它的都讲得很不错, 我虽然水平不高, 但是转载, 总结性, 都会写上原文地址, 参考, 转载, 才发现自己那么靠谱 哈哈

回复

载入中...