如何写好一篇技术分享文章-技术分享-有有码-技术经验分享网
当前位置: 首页 技术分享 如何写好一篇技术分享文章
编者按:本文作者是蚂蚁集团前端工程师依枫,梳理了一些写技术分享文章的要点,目的是为了帮助技术同学更好的编写技术分享文档,欢迎一起交流~前言最近部门在推技术分享的沉淀,每个小组平常也会有自己的技术分享。技术同学往往最擅长的是写代码,我们发现很多同学在做技术分享的时候,容易陷入仅仅把自己做的事情罗列出来

如何写好一篇技术分享文章

技术分享 发布日期:2023-10-22 21:16:15
48
文章简介:编者按:本文作者是蚂蚁集团前端工程师依枫,梳理了一些写技术分享文章的要点,目的是为了帮助技术同学更好的编写技术分享文档,欢迎一起交流~前言最近部门在推技术分享的沉淀,每个小组平常也会有自己的技术分享。技术同学往往最擅长的是写代码,我们发现很多同学在做技术分享的时候,容易陷入仅仅把自己做的事情罗列出来
特别声明: 购买前请先点击该产品链接,确认能打开/下载再购买!
详情内容

编者按:本文作者是蚂蚁集团前端工程师依枫,梳理了一些写技术分享文章的要点,目的是为了帮助技术同学更好的编写技术分享文档,欢迎一起交流~



前言

最近部门在推技术分享的沉淀,每个小组平常也会有自己的技术分享。技术同学往往最擅长的是写代码,我们发现很多同学在做技术分享的时候,容易陷入仅仅把自己做的事情罗列出来的误区,难以收获好的分享效果。


本文基于自己之前做技术分享的经验,同时结合了组内同学的建议,梳理了一些写技术分享文章的要点,目的是为了帮助技术同学更好的编写技术分享文档。


明确你的分享对象和分享目的

明确你的分享对象:这次分享面向的是什么样的对象?同小组的技术同事、大部门的技术同事,还是社区的技术同学?


明确你的分享目的:你做这次分享,目的是为了对方能够从中收获什么,是希望了解怎么实现这个技术方案?是希望能够找到适合的场景去用这个方案?是启发读者在类似场景去做更好的方案设计?还是抛砖引玉希望读者持续关注你的开源技术栈?


大纲体现了你的分享思路

💡 大家可以先想一个场景,阅读一本书的时候,我们会最先做什么事情:是不是会先看一看目录,了解下这本书大致有些什么内容、每个章节的重点有哪些?


技术分享文章也是一样,读者从标题点进来,首先需要看的这篇文章的大纲。


所以,我们作为技术文档的编写者,要重视大纲,先大纲后内容,大纲很多时候体现了你梳理这篇分享的思路。通过讲哪些点可以让读者清楚这件事情的前因后果,每个点之间通过怎样的递进关系可以让读者更好地理解?例如,技术分享文章,一般的大纲是 背景 -> 目标 -> 方案思路 -> 方案原理/细节 -> 达到的效果 -> 启发 -> 致谢。


大纲梳理清楚了以后,填内容也会变得更加容易。


先讲背景和目标

❗ 尽量避免上来就开始讲方案,读者大概率是一脸懵。


✅  不妨先讲讲背景,你为什么要做这件事?目前业务的痛点是什么,现状是什么,我们要怎么解决、希望达成的目标是什么。


✨ 对于一些先进性的技术方案,也需要讲清楚这件事为什么是前端做的背景:哪些事情是只能前端做的,哪些事情是前后端都可以做的但是更应该放在前端做的(讲清楚利弊)。


讲方案细节前先讲方案整体思路

❌ 讲方案的时候不要直接展开细节。我们需要知道一点:不是所有的读者都有技术基础能够看懂你的细节,也不是所有的读者都对你的方案细节有兴趣。


✅  先总后分,读者需要先有一个整体的思路去引导,先看到全局,再到每个点的细节。讲方案整体思路的时候,我们可以结合一些流程图来更加直观地表达。


讲方案细节的时候结合原理和举例

讲方案细节的时候,需要结合原理和举例。


原理是在讲细节前,先让读者知道这个东西是什么。


举例也很重要,说一大堆概念、讲一大段代码,读者可能并不能直接消化,但是,如果你结合这个场景举个例子,读者就能更容易理解了。


show 出你达到的效果

从背景到思路到细节,读者还想要关注,这个方案,究竟有没有达到上面的目标?这个方案牛,它有多牛?这个方案效果究竟是啥样的,我能不能用?


究竟有没有达到上面的目标:结合上面称述的背景,给出实现的效果截图(有对比图更好、必要的话动图比静图更直观);


这个方案牛,它有多牛:对比已有的技术方案,改进的点是什么,有没有指标可以量化、对比;


这个方案效果究竟是啥样的,我能不能用:方案除了解这个背景的问题,是否具有可扩展性,哪些场景可以通用的可以列出来,或者一些未来的思考;


方案背后的启发

✅ 不仅仅是完成了本次的技术方案,通过这次方案,给自己以及其他同学带来了哪些启发:


沉淀有哪些可借鉴复用的技术方案;


突破了哪些技术先进性;


提升了哪些领域认知;


抽象了哪些关于设计方案的思路。


最后的致谢

很多时候,厉害的方案都是很多人共同的智慧。过程中,如果有对你有帮助的同学,可以在文章最后列出来感谢一下 💐。相信大家也有被@过的感觉吧,感恩的心也是愉快合作的开始。


好的,在这里我需要@一下我的同事苏泊,感谢给大家提供的关于写文档做分享的建议,一起加油,共同成长。 作者:支付宝体验科技 https://www.bilibili.com/read/cv23248685/ 出处:bilibili


本站提供的一切软件、教程和内容信息仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络收集整理,版权争议与本站无关。您必须在下载后的24个小时之内,从您的电脑或手机中彻底删除上述内容。如果您喜欢该程序和内容,请支持正版,购买注册,得到更好的正版服务。我们非常重视版权问题,如有侵权请邮件与我们联系处理。敬请谅解!邮箱地址:353158001@qq.com

猜您喜欢坚持每天更新,让您每天都有新鲜的文章阅读

自己创业需要注意些什么?

自己创业需要注意些什么?

在当今社会,越来越多的人选择创业来实现自己的梦想和追求。然而,创业并不是一件容易的事情,需要充分的计划和准备。本文将探讨在创业过程中需要注意的几个关键因素,希望能为那些正在或计划创业的人们提供一些有益的建议。首先,确定合适的创业方向是非常重要的。选择一个适合自己的领域和项目,可以大大增在加选成择功创...

48推荐
人工智能

人工智能

技术是当今社会不可或缺的一部分,随着时间的推移,新的技术不断涌现,人们也需要不断更新自己的知识。在2023年,有八项技术备受关注,被认为是当今最热门的技术。接下来,我们将详细介绍这八项技术,并分享一些相关的文章。第一项技术:人工智能人工智能是近年来最热门的技术之一,它已经渗透到了我们生活的方方面面。在20...

48推荐
创业路上的坎坷与机遇

创业路上的坎坷与机遇

创业,是一条充满荆棘与机遇的道路。在这篇文章中,我将分享我的创业经历,以及在创业过程中所遇到的挑战和机初遇创。时期,我和我的团队在一个小小的办公室里开始了我们的创业之旅。那时候,我们充满了激情和干劲,但同时也面临着由很于多资困金难紧。张,我们不得不在成本上精打细算,从办公用品到人力资源,每一个决策都...

48推荐
小本投资项目做些什么好?

小本投资项目做些什么好?

小本投资项目做些什么好?投资是一项重要的决策,对于小本投资者来说更是如此。以下是一些小本投资项目的建议,希望能够为您提供一些帮助。1. 找到自己的兴趣爱好在选择投资项目之前,您应该先找到自己这感样兴可趣以的让领您域更。容易接受这些项目,并投入更多的时间和精力。例如,如果您喜欢摄影,可以考虑投资开设自己的...

3650资源个数(个)
98本月更新(个)
21本周更新(个)
3今日更新(个)