这样,才是我想看的技术文章

前言

可能作为程序开发人员会遇到很多读技术文章的机会,但是经常遇到文章读一遍下来会遇到各种问题。
首先是读下来不感兴趣,都不知道文章要说些什么;或者 读不动,通篇讲的都跟教科书的内容有得一拼,或者是文章太难了,读不懂,文章内容太晦涩,读起来跟读天书一样;又或者读起来读不通,这里懂一点,我看下,那里读不通,我跳过,最后下来能吸收的就一点点,又或者是其他的问题,这里就不列举太多。所幸自己也读到了不少好的作者写的文章,觉得他们写的文章让人学习起来就比较舒服、自然,而关于他们写作的时候的特点,如何阐述一个技术问题、然后分享技术知识的,有很多不错的特点可以学习起来。

下面是我的一些总结,可以给同行一起讨论下是不是这样的文章才是你想看的文章, 也为以后自己写出更好的博文,做一个方法论的探讨跟指导。

要求

  • 0、前言,围绕的背景,解决的是一个什么样的,开发场景中可能遇到的问题,一开篇上来就开始丢技术描述,我很难往下看,也不知道是不是我要读的。
  • 1、列举本文所涉及的关键字,以及关键字的解释,避免读者遇到的时候产生畏难心态,读一半然后读不下去。
  • 2、文章要有架构,总分总,还是总分,还是抛出问题,然后围绕问题展开收集,分析,假设,论证,总结。
  • 3、文章讲解的时候要通俗,不然用流水式,贴引用的文字、百科内容,(所谓的不讲人话),别说别人,自己都看不懂,要有例子、结合能够让人理解的最简单知识层面,阐述出来的例子,经过自己思考的描述之后,然后再加工出来能让人更好的理解。
  • 4、文章要有实用性,你贴了个方案,代码没有,那疑问还是在那呀,怎么用代码实现,是不是连你都不知道,你可以贴核心的关键代码,点到即止,可以阐述到解决自己的问题就行。
  • 5、对比,你的方案,你的问题跟别人不一样的地方,好在哪?优化在哪?哪里不一样了?你能怎么说服别人。
  • 6、文章要有图片,有到位的图片解释,可以有锦上添花的效果。增加文章的多样性。
  • 7、总结。‘结案陈词’ ,写完之后来一个总结,用一个脉络穿起前面讲的知识点。不然一篇下来,自己跟读者都不知道讲了啥,让彼此来复述一遍,可能都讲不出来。如果用图更加形象,可以是用一个思维导图,我见过好的文章里面会有一个用思维导图的总结,起到的总结作用比文字来得更好。

总结

0、前言背景介绍,
1、引导读者,
2、列举可能遇到关键字及解释,
3、结合自己认知通俗性阐述,
4、内容要有实用性,
5、技术的对比,
6、内容多样性,
7、内容的总结。

说实话,感觉自己要写出来这样的文章都会觉得难,但是当从一个读者的角度来想自己的文章是不是可以让人读懂接受,是一个比较好的侧面来要求提高自己的博文水平跟质量吧。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 197,814评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,124评论 2 375
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 144,814评论 0 327
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,924评论 1 268
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,815评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,562评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,944评论 3 388
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,582评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,859评论 1 293
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,881评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,700评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,493评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,943评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,115评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,413评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,978评论 2 343
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,182评论 2 339

推荐阅读更多精彩内容

  • 从这张图看 1.案主的安全感,案主和生母和继母的关系线很粗,我个人认为并非真正意义上的关系好,而是期待,由于她从小...
    张慧哲阅读 624评论 0 1
  • 很想念她 晚上想着她逐渐进入梦中 梦中显现她的样子 梦中有欢乐喜悲 梦中有她,有我。 醒来时发现不在身边
    位森阅读 132评论 0 0
  • 磕磕碰碰的人生总是在所难免的, 即使再艰难, 再心酸, 生活总是得靠自己创造。 也许扛得住艰难的时光, 顶得住难过...
    林枫随心阅读 85评论 0 1
  • 每天我们都生活在车水马龙的平行世界中,希望有一个牛奶箱可以寄往自己的烦恼,欢迎留言,愿意帮助解决你的烦恼
    信箱1阅读 98评论 0 0
  • 两岁时,我便和母亲在这所乡村小学安家了。母亲是学校的校长,既要教书,又要管理学校的诸多事务,实在腾不出时间来照顾我...
    云散月明阅读 286评论 0 2