IT/互联网行业的工作者如何写好技术类文章?

  1. 云栖社区>
  2. 博客>
  3. 正文

IT/互联网行业的工作者如何写好技术类文章?

技术小胖子 2017-11-08 19:18:00 浏览1052
展开阅读全文

  本来想写一下今天解决的一台DNS服务器因为DNS视图配置错误导致另一台DNS服务器上的客户端无法访问Internet域名的严重问题,一开始就写成如下的内容(严重跑题了)。

  作为IT/互联网行业的工作者而言,写一篇技术类文章并发表到博客上一定是为了让更多的人看到这篇文章,而且都是希望这篇文章对大多数人都是有用价值的。越是有价值的文章越“流传”的久远,那怎样的文章才具有价值呢?我认为最简单的回答就是能用。所谓的有价值有意义都是为了能用而言的。试想一篇不能用的文章还叫做有价值有意义么?以下是总结的几点想法(本文显然不符合下面这些要求)。

  1. 文章标题与内容相关一致,文章长短适中,读者喜欢看(阅读体验)

  2. 提前表明本文针对的读者人群,适合什么样的人阅读,使用的什么样的环境等

  3. 精确含义,直截了当,表达严谨,抓住问题本质,能用图表达的就不用文字表示

  4. 能易于理解,描述清晰明白,不产生歧义

  5. 能有效的解决实际问题,或为解决实际问题提供参考,或具有启示作用(功能)

  6. 方法简单高效易用,合情合理,操作步骤少,减少机械性操作

  7. 充分考虑到各种问题、细节和可能发生或将来可能会发生的任何(足够多的)(应用)场景

  8. 术语尽可能的解释清楚明白和正确,引用的知识和链接正确和完整,尽可能的传达更多信息

  9. 最好有解决思路和具有概括性质的摘要或总结,这样即使篇幅较长,也能收获一些

  10. 反复斟酌,润色修改,使得语句通顺,衔接连贯,保留有用信息,去掉无用的信息

  11. 合理排版、使用字体格式、标注等

  12. 技术文章不同于文学作品,但文学中很多东西可以用于技术文章的写作,此处略去好多字

  13. 多查、多学、多记、多练、举一反三,此处略去更多字

  写这篇文章过程中跟我们公司的UI/UE设计部门的经理东哥(来自中央美院艺术系的大帅哥)聊起来,“这写文章和做设计和做产品之间有什么区别?”我还自以为是抛砖引玉的先说了句“用心”,东哥说最重要的是积累,东哥没有用“其实是”、“可能是”、“觉得是”这样的词,这让我对东哥非常佩服。东哥说无论是做设计还是做产品,没有积累足够多的经验、构思、素材、想法等(记不住,省略好多字)是做不出一个让人觉得牛逼的东西的。但很多东西又都是系统的,有它自己的规律。互联网上充斥着许许多多的点(数据、知识、方法、想法),让人觉得这么多的点很难学完很难掌握,但实际上这些无限的点都是围绕着一个系统中的几个关键构成(关键的点)而形成的。人类眼中色彩斑斓的世界仅仅是三种颜色按照不同的配比做成的。无论是设计还是产品都是两个因素作为考量,一个就是实用,一个就是美观。说起最简单的杯子,杯子的种类和造型有千千万万。喝茶的,运动的,保温的,养生的这些都是功能,而很多功能又要结合美观去改动。例如氧化水用的金属钴就可以做成很多不同的形状或设计有不同的条纹。太师椅的设计主要就是为了功能,为了让“太师们”正襟危坐而让人感觉并不舒服。一个人没有见过真真正正的作品是无法做出牛逼的东西的。当无法做出一个令自己满意的作品时,我就要参考其他的设计,例如我要设计一款手机,我可以参考汽车是如何设计的,实在找不到头绪就看看大自然中有哪些东西可以让我使用,摸清这些规律和以这些作为参考,就能有一定的想法和构思。东哥还谈起了与美术设计非常相关的摄影艺术和建筑设计,包括摄影构思、设计风格、颜色配比、光影处理、苏州园林、贝津铭的作品(包括苏州博物馆等)、罗中立的《父亲》、真正的中国风(包括火炬设计)等。想起很多人都喜欢的旅游,去看看这些也相当不错。国人跟国外的差距就在于,国人觉得差不多就行了,而国外却追求极致,听到此处我内心的完美主义更浓重了几分。

--end--





本文转自 urey_pp 51CTO博客,原文链接:http://blog.51cto.com/dgd2010/1629760,如需转载请自行联系原作者


网友评论

登录后评论
0/500
评论
技术小胖子
+ 关注