写技术文的三个原则是什么?

本文章原创首发于公众号:编程三分钟

我关注了很多技术类的公众号,看着大佬的公众号几千的阅读量,甚是羡慕,这直接导致了我没有心情减肥,甚至多吃了一个鸡腿。

要怎么才能写出一篇好技术文章,让读到的人感到身心舒畅,快速Get到想说的点,我想破了脑袋。

喜欢读我文章的人多少都和互联网行业沾边,像咱们这一行加班是常有的,看文章的时间也比较琐碎:蹲厕所、挤地铁、吃饭、睡前玩手机。基本就是这四个时间,不是正在做就是在去的路上,有木有?!

要在有限的几分钟里,让看的人能够流畅读完,并且掌握表达的点,是一个很有难度的事情。

我总结了一下,重点有三个:

  • 精简
  • 有趣
  • 成体系

精简

  • 精简,就是不说废话,珍惜读者的时间,把注意力集中在关键知识点上,最好在文章开始就能点明主题。
  • 绝不要大段的引用和铺概念,一旦出现这种情况,中间也没夹杂有趣的部分,很容易产生抵触情绪,这直接影响到阅读体验,像我这种爆脾气,要不是因为穷,直接就把手机摔地上了。

有趣

要让文章变得有趣起来,可读性强。

  • 发挥出全身上下的幽默细菌,适当写些段子无伤大雅,甚至可以加入一些故事情节,让人回味无穷。
  • 专业名词少用,说话越土越好越容易让人理解。别整天扯那些名词,又不是在写论文。
  • 有图千万别写字,有表格用表格,一张图胜过千言万语,当然了,能用动图就更棒了!

当然,有趣是建立在精简的基础上,又不是在写童话书,突出重点,把握好火候。

成体系

我看到很多大神技术水平很强,但是喜欢站在自己的角度上说技术,别人基本没办法看懂,写出来的文章也只能自己看。

在这里我特别想说,当我们在看一篇文章或一本书的时候,看个几行心里面产生一种情绪,“啊,太难了,我好菜啊!” 这不是我们的错,而是写文章的人的问题。

写技术文章不是写流水帐,要有脉络,从易到难,循序渐进,针对一个新概念要想清楚表达的方式。拆分难的知识点成小块,最后再联系起来。让人一下子看懂,成就感满满!我比较喜欢问自己:

  • what ? 我要讲的点是个什么东西?
  • why? 这个东东能做点什么,有什么用?
  • how? 要怎么做才能用上(实现)

最后

编程三分钟从4月27号开始到现在已经有整整五个月了,谢谢大家对小熊(我)的支持,风里雨里,我在等你。加油!

原文地址:https://www.cnblogs.com/pzqu/p/11602657.html

时间: 2024-11-09 10:47:19

写技术文的三个原则是什么?的相关文章

每天坚持不懈的写软文,得到的几点心得感悟

夜深了,我喜欢这样宁静的夜,它能让人不用去想更多的事情,专注于做自己想做的事情,我认为是一种幸福的事情,拿着手机播放了今晚的<半夜听>节目,听这个节目已经有一段时间了,虽然每天只有那么短短的几分钟,但是那些字眼确实令我欲罢不能,听完几分钟的半夜听后,顺手热了杯特仑苏牛奶,年轻自然需要多补脑,热牛脑的几分钟,就收到一位SEO朋友的咨询,聊着聊着最后笔者以一句"你先休息吧,我还要写稿!" 朋友便调侃式地问我,你每天坚持写作那么久,得到了什么吗? 一般被别人遇到这个问题,我都不屑

为什么要写设计文档

日趋一日,程序员能够在更少的时间内完成更多的事情.使用今日的高级编程语言,开发环境,工具和“快速应用开发”思想,程序员和经理都已经习惯于急速的开发周期.今日的程序员更倾向于直接跳入到编码之中,害怕花费在非编码工作中的每一小时,都会导致项目截止日期前的周末多加一个小时班. 编码之前做设计这一过程已经变得过时了,将设计文档化就更罕见了.很多程序员从来没有写过设计文档,面对要写设计文档这一想法都畏缩不前.即使被要求写,通常来说也只是产出了一大堆的交互图和类图,这些图表大多没有表达程序员在设计阶段的思考

Xamarin技术文档------VS多平台开发

此技术业余时间研究,仅供大家学习参考,不涉及深入研究,有一定开发基础的人员,应该都能较快上手. 一.简介 Xamarin始创于2011年,旨在使移动开发变得难以置信地迅捷和简单.Xamarin的产品简化了针对多种平台的应用开发,包括iOS.Android.Windows Phone和Mac App.Xamarin由许多著名的开源社区开发者创立和参与,而且也是Mono项目的主导者--C#与.NET框架的开源.跨平台实现. 作为一个跨平台开发框架,Xamarin.Mobile有很多优点.在这一框架内

Boost.Asio技术文档

Christopher Kohlhoff Copyright ? 2003-2012 Christopher M. Kohlhoff 以Boost1.0的软件授权进行发布(见附带的LICENSE_1_0.txt文件或从http://www.boost.org/LICENSE_1_0.txt) Boost.Asio是用于网络和低层IO编程的跨平台C++库,为开发者提供了C++环境下稳定的异步模型. 综述 基本原理 应用程序与外界交互的方式有很多,可通过文件,网络,串口或控制台.例如在网络通信中,完

有效处理java异常的三个原则

Java中异常提供了一种识别及响应错误情况的一致性机制,有效地异常处理能使程序更加健壮.易于调试.异常之所以是一种强大的调试手段,在于其回答了以下三个问题: 什么出了错? 在哪出的错? 为什么出错? 在有效使用异常的情况下,异常类型回答了“什么”被抛出,异常堆栈跟踪回答了“在哪“抛出,异常信息回答了“为什么“会抛出,如果你的异常没有回答以上全部问题,那么可能你没有很好地使用它们.有三个原则可以帮助你在调试过程中最大限度地使用好异常,这三个原则是: 具体明确 提早抛出 延迟捕获 为了阐述有效异常处

40.用创业思维复盘:写技术博客到出书

在2013初,笔者把过去两年开发app后端的经验总结成十多篇文章发表在博客上,那些笔记发表以后的反响出乎本人的意料,本人从网络上得到网友的支持和肯定,证明这些知识还是有价值. 2013年离开了当时的创业团队后思考今后的技术方向,当时笔者已经开发过两个社交app的后台,对开发app后端的流程比较熟悉,但是从技术发展的角度来看,笔者缺乏开发大流量大并发的技术经验,在今后的职业发展上必须填补这方面的空缺,因此就职时倾向于选择一些有大流量的公司. 当时笔者只投了两家企业,最后都拿到了offer,一个of

使用docsify 写开源文档

使用docsify 写开源文档 官网:https://docsify.js.org/#/ docsify 是一个动态生成文档网站的工具.不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行. 这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件"污染" commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages. 一.初始化

Atitit usrQBK1600 技术文档的规范标准化解决方案

1.1. Keyword关键词..展关键词,横向拓展比较,纵向抽象细化拓展知识点1 1.2. 标题必须有高大上词汇,参考文章排行榜,1 1.3. 标题带语言关键词c#.net js javascript  c++ python1 1.4. 标题最好有英文版本的,方便英文查询1 1.5. 标题atitit前缀,attilax总结结尾方便查询1 1.6. 标题后面带上版本号v2 qbf等,方便时间对比1 1.7. 正文要求 修辞好(引用典故名句,成语 等,使用修辞方法)2 1.8. 引用寓言故事 类

如何快速阅读并理解英文的技术文档

作为一名程序员,要实现我们的产品,首先需要选择一种或几种编程语言,其次是使用各种工具和第三方库. 而在这个过程中,就少不了对这些语言.工具和第三方库的下载和学习. 下载一般都非常简单,但是关于如何使用,相信大家都会有各种各样的学习方法. 但是不管通过什么方式,追根溯源都会来到官方文档. 那么问题就来了!目前来说,大部分的官方文档都是英文的,如何才能快速的理解并使用官方文档呢? 今天,把自己的学习方法拿出来,和大家一起分享一下,希望大家可以尽量少走一些弯路,尽快的找到bug的解决方法. 说起来很简