一篇好的技术文章应该什么样

资讯 3年前 (2022) admin
546 0 0

注:本文所说的技术文章指网络安全类技术文章,不包括网络安全资讯、网络安全观点等

    在日常学习的过程中,经常需要阅读别人的技术文章,这些文章的质量有高有低,有些甚至还存在错误,极大影响学习效果,所以在一番思考后写下此文,简单谈谈在我眼中好的技术文章是什么样的。

图文并茂

    在读一些国外的文章时,可以发现他们大部分有一个显著的特点:图很多且生动,包括各种流程图、模型图、架构图,通过这些图能比较直观地理解作者想要展示的概念或者技术,如:

一篇好的技术文章应该什么样

    笔记类的文章自然不必讲究这一点,但如果是布道式的公开文章,图文并茂既能降低阅读门槛,也不会引发读者的阅读疲劳。

条理清晰

    不论是实战类还是技术介绍类,文章的脉络都应该是非常清楚的。实战类自然是从开始介绍到结束,不必事无巨细,但应该突出自己思考和尝试的部分,并省略一些最基本的技术介绍,毕竟流水账式的文章在初中都会不及格。技术介绍类文章应该与学术论文结构相近,从技术的背景知识和概念开始,再介绍其发展过程和历史,然后阐述其原理和应用,最终给出结论。

准确无误

    这一点其实是最重要的,因为如果传达了错误的信息给读者,那么其作为技术文章肯定是不合格的。不仅仅是事实性的错误,一些概念的规范性表述、称呼也应该保证统一,如不少文章会将Windows域内的服务票据称为TGS票据,这一点Moriarty师傅在星球中指出:

TGS全称是Ticket Granting Server,是KDC的一个组成部分,并不是票据。票据只有TGT和ST两种,所以类似“请求了一张TGS”、“用户的TGS”的表达都是存在问题的。

    事实性的错误也有很多,不管是漏洞复现还是技术复现都应该自己动手尝试,保证PoC或者环境的准确性,避免闹这种笑话:

一篇好的技术文章应该什么样 一篇好的技术文章应该什么样

减少口语化表达

    非常多的作者在刚开始写技术文章时都无法避免这点,这是提升文章观感的一个比较重要的点,能够给读者展示作者专业性的一面,多加练习很有必要。

范例与反例

    最后来看几篇正反面教材,首先是反面教材,用我几年前写的一篇文章举例:

一篇好的技术文章应该什么样 一篇好的技术文章应该什么样

一篇好的技术文章应该什么样

    可以看出这篇文章就是纯粹的水文,里面充斥着各种无意义的废话和卖萌词汇,读完感觉自己浪费了生命中宝贵的两分钟,大家引以为戒。

    再展示优秀的文章,实战类文章里我认为@yangyangwithgnu师傅的这篇文章非常好:《全程带阻:记一次授权网络攻防演练》(https://www.freebuf.com/vuls/211842.html)

一篇好的技术文章应该什么样

    可以看到对于脆弱点,@yangyangwithgnu师傅都会展示出他思考的过程,如同一位国手,每走一步都会考虑到后面几步的走法。

    技术介绍类文章我推荐@3gstudent师傅的文章写法,如:

一篇好的技术文章应该什么样

    文章脉络清晰,读起来如一篇严谨的学术论文,作者的专业性毋庸置疑。

最后的最后

    写本篇文章是有感而发,并非为了嘲讽出现上面所述问题的文章。希望大家的技术水平都能越来越强,技术文章也越写越好,这样我才能更加愉快地白嫖(滑稽)。


原文始发于微信公众号(白袍的小行星):一篇好的技术文章应该什么样

版权声明:admin 发表于 2022年3月23日 上午12:19。
转载请注明:一篇好的技术文章应该什么样 | CTF导航

相关文章

暂无评论

您必须登录才能参与评论!
立即登录
暂无评论...