IT论文----如何写技术论文

    作为《程序员》杂志的技术主编，我要审阅每一篇技术稿件。几年来我了解到的一个事实是，现在绝大部分开发者的写作和文字表达能力远远不如他们写代码 的能 力。如果你认为你只需要跟机器搞好关系就可以过上幸福生活，我可以说这几乎是不可能的。任何时候，让人明白都比让机器明白更重要，更有价值。很可惜，不知 道是什么原因，现在能够清清楚楚有条有理地把自己的想法表达出来的人越来越罕见。无论是从编辑的招聘和培养，还是投搞的评审，我都不得不痛苦地面对这一事 实：很多人在用中文表达思想这一基本能力上是不及格的。

     这并不是说我设置了过高的 要求，绝非如此。恰恰相反，我的标准很简单，你只要观点清晰，条理分明，就算达标。说白了，不管你是对是错，至少要让人家知道你在说什么。有这一条就可 以。我自己的写作水平也不高，特别是平时精力不足的时候，写出来的东西也就是清楚而已。然而我看到很多人，特别是那些自以为自己水平不错的人，他们的文 章，如果用文学化的标准去衡量，特别是网络文学的标准去衡量，也许其中有不少算得上是不错，可 按照我这个低标准来要求，就有相当部分不及格。他们的文字颇得意识流精髓，随心所欲，恣意横流，如果你是想从一篇Java正则表达式的文章中体验到个体对 于后现 代社会的无奈和迷失心态，或者体验嗑药的迷糊感觉，也许这样的文字并非一无是处。可是如果你的目标就是想尽快了解正则表达式怎么用，那就惨了，很有可能你 看了半天不知道他想说什么，听了半天不知道他想讲什么，拉里拉杂，稀里哗啦，就像被汽车压过的烂西瓜在桑拿天里发了酵，一地烂瓤，惨不忍睹。

     对比一下老外。我曾经邀请过一些老外写文章，他们有的人还很年轻，有的人非常紧张地告诉我，他们从来没有写过杂志文章（在美国，能够给杂志写文章是很荣耀 的事情），一定写不好。但是真的看到文章本身，我就发现，他们可能没什么文采，可能缺少一点艺术性，更不太会有古龙或琼瑶式的语言，但是写出来的东西就是 清楚。是什么、为什么、怎么样，一条一条有根有据，让我这编辑欢喜的紧。

    《程序员》是技术刊物，技术刊物求的是什么？就是让读者学有所获，感有所悟。都象这帮老外似的把话说清楚，不就结了吗？技术文章跟文学作品不一样。文学作 品能够粘住读者那是上品，让读者如痴如醉死去活来，甚至在百家讲坛里与天下人对饮赏析，那是绝妙之作。可是技术文章很简单，读者要知识，你以最高的效率， 最清晰的方式告诉读者他所需要的东西，就是上品。倘若能够让读者读过以后印象深刻，逻辑完整，那就是妙品。如果你也打算让读者开个讲坛来揣度你的曲笔和隐 喻，对不起，这样的文字我们消受不起。

     通过对编辑部里年轻编辑文字的观察，我发现我们很多人写作说话不成条理的一个重要原因，就是不列提纲，或者不会列提纲。说白了就是讲话不打草稿，想起一出 是一出，大笔一挥，就开始脚踩西瓜皮，滑到那里算哪里。有的形式上列上几条，可你看看哈，彼此之间谁也不挨着谁，根本没有一个中心意思，不成其为结构，是 计划好了的脚踩西瓜皮。其实在种种改进技术文章的方法里，列提纲是最简单、效果最显著的一种。提纲就是全文的思想浓缩，你把提纲读一遍，意思要明白、 结构要完整，条理要清晰，有了这三条，文章已经成功了一大半。

     我把自己列提纲的一些方法与大家分享，希望能对有心人有所帮助。也不是针对所有类型的文章，比如按时间线索展开的文章，就不适合以下结构。

0. 短文可以腹稿，但是整个过程不能略过。长文必须列提纲。
1. 一篇文章，中心思想只能有一个，而且可以用一句不带逗号的陈述短句或疑问短句讲出来。
2. 为支持这个中心，需要2-4个支撑点，它们可能是：是什么、为什么、怎么做、会怎么样。
3. 按照读者逻辑来组织文字顺序，想一想读者看到这些观点和文字，会提出什么问题，于是设定结构回答这些问题。
4. 小标题和每一段的第一句话都要直切主题，告诉读者这一段是讲什么的。可以在列提纲的时候就写出来。
5. 列好提纲再动笔，有什么巧妙的想法和句子可以暂时记在一旁。

     有一本书叫《金字塔原理》，对于写作和表达的方法进行了很好的总结和归纳，比我的经验高明得多。可惜据说已经绝版了。

转自 孟岩的blog

评论

1 楼 kong_desheng 2010-03-18  

确实如此，中国程序员的文字表达能力非常差！根本上讲，还是思维不清楚，直接导致的后果是在工作中沟通差、产品文档条理不清，代码的逻辑实现过程也是比较混乱的。在代码走读过程中，这种现象比比皆是。