如何写出一篇高质量的技术分享文档

自己也写技术分享文章,也经常看别人的分享文章,本篇就简单梳理梳理个人的一些看法,希望能给一些准备写技术分享的同学一点帮助。

优先确定技术文章面向的受众是初级、中级还是高级、资深人员,面向不同的人群,所需措辞也不同,同一个词因人不同的知识结构会导致不同的解读,所以尽量减少这种不必要的消化损耗。文章真正被阅读的受众,这个是无法控制的,事先定好基调就比较容易把握文章深度,浅显易懂最好不过了。

其次要考虑到技术应用的上下文环境,这个要交待清楚,能解决什么问题,适用在什么场景下,如果能把类似的解决方案顺便提一下,更能阅读受众的知识面。

多使用图表。一图胜千言,对于晦涩的算法、流程、结构等,一张漂亮的图,那怕是草图,也能使读者很容易走近文章的世界,吸收文章的精华内容。相比满屏的文字,图表会花费较少的时间被阅读接受。

新名词的使用要引出简要的注释,便于读者消化吸引。由于知识诅咒的存在(通俗地说,就是一旦你知道了一个信息(学会了一样东西),你就很难想象你不知道该信息(没学会该东西)的情景。),总会有一些我们常用但别人却不懂的名词存在,这会加大阅读的难度,也会给读者一个放弃文章不再阅读的选择。

如果我在一篇文章中碰到了一个新名词,一般来讲我会去检索弄懂,如果另外的文章中还有,则会引起一连串的检索,那本来我要读的那篇文章就会越为越远离我的视线。当然,我没读完的有兴趣文章,一般也不会关闭,至到把所有新名词弄懂。

要不要贴代码。不少同学的博客里出现大篇的详细代码,但读者去用的话,有时候完全不能运行,导致错误百出。自己的环境里上下文里有的东西,别人不一定有。

如果你决定贴代码,就要顺便把代码中的引用一并讲清楚,这对有帮助的人来讲,将会对你感激不尽。(一般有现成的代码,大家普遍喜欢直接Copy,而不是自己消化后自己写一篇,这不符合Ctrl+c/Ctrl+V编码的风格)当然有些读者会要求人,为什么不这样那样,这是当事人涉及的另外一回事了。

如果不贴具体代码,可以采用伪代码替代。即讲清楚了实现的逻辑,也避免了读者直接copy代码导致的各种问题。

文章的延伸性一篇好文,读完酣畅淋漓,受益匪浅。不过有时候总有意犹未尽的感受,这个时候如果能适当的扩展一下,引申出更多的方向

640?wx_fmt=jpeg

题图 from unsplash

说完里子,再说面子,一篇条理清晰、结构融洽的文章读起来总能事半功倍,富文本编辑也好,Markdown编辑也好,较适当的内容以适当的格式表现出来,文字大小适中,段落控制得当等,多写几次基本就轻车熟路了。

行文的可读性有些文章比较晦涩,但通过形象的比喻,能够助于读者更好的理解接受,远比一篇全是生硬的术语堆积起来的文章更加能够吸引人的。原理总是枯燥的,但小故事永远总会吸引人的。

虽然这篇文章质量高在读者看来高低未可知,但是我也总希望别人写的文章能达到以上的条件,一同努力。

640?wx_fmt=png

往期推荐:

长按2秒,识别二维码,关注我

640?wx_fmt=jpeg

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
### 回答1: Postman是一款非常实用的API测试工具,是专为开发人员设计的HTTP客户端。它的界面友好,使用简便,支持多种HTTP请求类型,如GET、POST、PUT、PATCH、DELETE等,可以方便地测试Web应用程序的API。而Postman技术分享文档则是教授使用Postman的技巧和方法,旨在帮助开发人员更好地利用Postman测试API。 Postman技术分享文档的内容非常丰富,可以涵盖如何通过Postman发送HTTP请求、如何设置请求头、设置请求参数、设置身份验证等方面的内容。此外,Postman技术分享文档还可以详细介绍如何使用Postman进行API测试,如如何进行单元测试、集成测试、端到端测试等。 通过学习Postman技术分享文档,开发人员可以更好的利用Postman进行API测试,简化测试流程,减少出错率。同时,Postman技术分享文档还可以让开发人员更好地了解API测试的原理与方法,提高其测试技能和测试效率。 总之,Postman技术分享文档一篇非常值得阅读的技术文档。它可以深入地介绍Postman的使用技巧和测试方法,帮助开发人员更好地利用Postman进行API测试,提高测试效率和质量。 ### 回答2: Postman是一款广泛应用于API测试、开发以及文档编写的工具。它的优点是易用性高,可扩展性强,支持多平台和多种数据格式。 在这篇技术分享文档中,我们将深入了解Postman的各种使用方式和功能。 首先,我们会介绍Postman的基本使用方法,包括如何创建请求和测试集合,如何使用环境变量和预请求脚本等。 其次,我们会探讨Postman的进阶使用方法,比如使用测试脚本、使用集合运行器、使用Monitors进行自动化测试等。 然后,我们会介绍Postman的高级特性,如使用API schema、使用API行为文档生成器等。 最后,我们会讲解如何使用Postman来进行API文档编写,包括利用Postman的Markdown支持、使用API Blueprint等。 总的来说,本技术分享文档将涵盖Postman的方方面面,让读者全面了解Postman的使用方法和优点,为API测试和开发工作提供更好的工具支持。 ### 回答3: Postman是一款广受欢迎的API开发工具,它可以帮助开发人员进行API测试、文档编写和协作管理等一系列工作。对于想要高效开发API的开发人员来说,Postman是一个非常有用的工具。 在Postman技术分享文档中,开发人员可以学习如何使用Postman来进行API测试,包括如何设置请求头、请求参数、响应状态码、响应正文等,从而保证API的正确性和稳定性。 此外,文档中还包括了如何编写高质量的API文档,包括如何描述API的功能、参数、返回值等,以及如何使用Postman的集成协作工具来进行团队协作和版本管理等。 另外,文档还提供了一些高级技巧,如如何使用Postman的变量和环境管理功能来简化测试流程,以及如何使用Postman的脚本功能来进行API自动化测试和构建。 总的来说,Postman技术分享文档是一份非常实用和全面的文档,可以帮助开发人员更好地使用Postman进行API开发和测试工作。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MavenTalk

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值