天涯论坛

 找回密码
 立即注册
搜索
查看: 91|回复: 6

怎么样写好一篇技术文案?

[复制链接]

2966

主题

144

回帖

9912万

积分

论坛元老

Rank: 8Rank: 8

积分
99129182
发表于 2024-7-13 12:12:52 | 显示全部楼层 |阅读模式

文字是咱们感知世界的方式。

今天分享一下关于怎样写好一篇技术播客的文案,这位作者总结的还是非常全面和到位的。

为么要写技术博客

关于这个问题,已然非常多大佬给过意见了。针对我个人来讲,写技术博客重点有以下几个出发点。

加深知识理解和把握

程序员群体非常多都挺爱学习,大众经常在工作之余看些技术书籍,刷有些公开课来开拓视野,提高技术水平。不外仅仅有“输入”其实是很难真正把握有些知识的,咱们必须结合各样方式的“输出”来验证自己所学的知识,例如动手实现有些原型,在机构项目中进行应用,做一个分享,写一篇博客来将这个新知识讲述给别人。当你在撰写技术博客时,会更加立体地去思考技术点暗地里的“What,Why,How”,非常多读书过程中想到的细节,暗地里潜藏的发展历程故事,都会在撰写过程中去持续挖掘完善。因此非常多时候咱们会说,做分享其实收益最大的并不是听分享的人,而是做分享的

完善个人“技术地图”

大众在工作几年后,逐步会进入到某些特定的行业进行深入的发展,在这个行业中可能有许多关联的技术内容,暗地里有千丝万缕的联系,而一系列的技术博客帮忙咱们整理,完善这些技术点,进行更高层次的思考和融会贯通的一种途径。一个比较有意思的例子是大数据和分布式系统行业的神书《数据密集型应用系统设计[2]》,书中附带了非常多关于这个行业的“技术地图”,非常的高屋建瓴。后续有新技术的显现咱们能够“映射”到这幅地图上去做整体性的思考,利用已有的累积和框架去快速理解新事物的差异点和创新之处连续累积必定数量的高质量博客后,咱们能够思虑出一本书,进一步扩大影响力

提高写作与沟通能力

这方面的能力针对技术人员的职业发展是相当有帮忙,之前在我的 资深工程师之路系列[3] 中有所介绍。做项目不但光是架构设计,代码实现,测试,发布运维这些偏技术的内容,非常必须项目道理的阐述,业务需求的沟通,架构设计的讨论与宣导,项目应用的推广与运营等跟沟通紧密关联要紧环节。论你想作为独当一面的技术大牛,还是带领团队的 tech lead,写作沟通都是非常要紧的技能,必须连续投入,刻意练习。

拓展人脉圈

个人的力量总是非常有限的,而如今的技术发展又是日新月异,高速迭代。非常多时候与其他专家的交流探讨能大大提高你对某些技术行业的理解,乃至机构急需某个方向专业人才的时候还有机会能够直接邀请大佬的加入,一块有些大事 运营优秀的个人/机构技术博客或开源项目,是一种非常好的打造技术品牌的方式,大佬肯定是更爱好跟高水平的同僚探讨合作的嘛。

生活记录

当然非常多技术人会写有些生活化的博客文案例如 pluskid 大佬的博客[4] 里就有非常多旅行,绘画,读书等方面的内容,读起来是精彩纷呈。平时写写博客记录生活,抒发情感是一种很好的消遣方式,说不定以后我能够尝试一下

怎样写一篇技术博客

这个部分,咱们重点来介绍一下写一篇技术博客的整体流程通常是怎么样的。

知道主题

比较平常的技术博客选题方式有几种:

针对工作行业体系性的技术介绍。例如做为算法工程师,能够系统性地介绍所在业务行业平常模型,她们的发展历程,暗地里相关,优缺点等。后端研发能够从各类框架工具,架构设计,系统组件等方面来选取关联的主题。这些选题能够和你个人的工作规划紧密的结合起来,例如这个季度打算做系统的云原生改造,那样能够集中火力调研一系列这个方向的技术专题,并总结成文案针对自己熟悉的技术,能够做深入剖析,做更高维度的提炼总结;针对有些不熟悉的新技术,能够边学习,边记笔记,后续整理成博客文案实战中碰到的疑难杂症的记录。个人还挺爱好看这类 debug 关联文案,尤其是哪些隐匿很深,难以复现的繁杂问题,能够经过高超的工具和技术层层抽丝剥茧,定位到根因并加以处理的经历过程。倘若说技术介绍的文案读起来像说明文的话,那样这种类型的文案就很像引人入胜的小说了。这类文案倘若处理的是一类大众经常碰到的问题,被搜索拜访的点击量会比较高。技术史话,名人传记,技术圈八卦的故事型文案。比较典型的表率有吴军老师写的《浪潮之巅》,飞总早年写的 大数据哪些[5],还有近期看到的 OneFlow 的专栏 科技星辰[6] 等。这种类型的文案要写的好,通常都是大佬级选手了,必须在行业累积了足够的经验和视野,经历了技术发展的跌宕起伏,才可把控得游刃有余,读起来是非常引人入胜。还有一类很受欢迎的文案是“导航型经验分享型”的。例如我之前写的 算法工程师技术路线图[7],可能由于大众都或多或少有点“保藏就等于看过”,“看了一堆目录就等于全都看过”了的心理 这种类型的文案受众会比较广,很容易得到高点击量,不外针对写作者自己来讲提高帮忙那样大。外文资料的翻译和诠释。有非常多优秀的一手技术资料都是以英文形式出此刻互联网上,例如顶级的学术会议,开源项目机构组织的研发者大会,推特,HackerNews 上的有些新的文案和讨论,高质量的外文播客等等。咱们能够结合自己有些经验,将这些内容翻译,搬运到国内的博客平台上。

大众能够按照自己爱好来进行选取,平时工作中能够多留意能够总结提炼的知识点,后续汇聚成文。

调研学习

个人习惯在确定主题之后,先做一番已有关联文案的调研学习。例如在知乎,Google 上搜索一下中文世界中已有的关联文案瞧瞧她们已然覆盖了那些内容,深度和广度怎样是不是有些咱们独有的认知说到,读者有有些什么样的反馈意见等。倘若发掘已然有写的非常完善的文案了,个人法作出多少额外的新贡献,我就会选取暂且搁置这个主题是不是继续撰写文案全部调研过程能够咱们学到不少新的东西。

素材累积

确定主题后,咱们能够起始着手做关联素材的累积,其中上一步的调研学习过程中,就能够有些看到的比较好的资料记录下来。针对有些新的知识,这个素材累积的过程可能会连续一段时间,必须更加多的书,文案,视频等来持续丰富自己的理解。以我之前写的走马观花 AutoML[8] 为例,光看各样论文参考断断续续就花了 3 个月。成为了写博客的习惯后,咱们能够连续做这类的素材收集工作,针对平时的阅读学习来讲会更有目的有些

确定大纲

起始正式进入到撰写周期咱们能够整体浏览一遍之前累积的素材内容,做有些区分归类,而后文案大致的框架脉络确定下来,例如能够把各层级标题先写下来画个思维导图针对现代读者来讲,大段的文字很容易让人失去耐心,因此规律条理清晰的分段分层非常要紧。这其实跟写代码时做有些模块划分的设计类似,个人比较习惯这种 top-down 的方式,后续写详细内容会非常自然流畅。写好大纲之后能够从初学者的方向带入来体会一下整体的阐述思路是不是清晰易懂,避免后期的很强的返工修改。

完成详细内容

倘若前面准备工作做的比较充分,这部分的工作总体来讲会比较顺利,比小时候写 800 字的作文要容易得多了有况且这部分能够非常多的自由发挥空间,例如有些人爱好经过讲故事的方式来做串联,有些人会穿插非常多精美的插图来帮忙理解,有些人相对平铺直叙,就会看起来比较“干”(例如我)。这儿有个小意见是除非文案的主题跟代码或数学讲解强关联,否则不要在文中加入比例过高的代码和公式尽可能详细的例子,配图等方式来简化有些繁杂的概念,能更好的帮忙读者理解核心思想。这儿比较好的范例是专门讲解数学的视频博主3B1B[9],用非常多可视化的方式把非常多繁杂的数学问题都讲得非常清晰透彻。

除了正文内容,咱们能够在其中穿插有些思考题,小故事等,保持读者的重视力,增多互动机会。例如王喆大佬之前写的一系列举荐系统的文案中每篇最后都会提有些问题来诱发大众的思考和讨论,效果非常不错。

审阅优化

完成撰写后,先别急着发布,能够以读者的视角再从头到尾读几遍文案有些伴侣帮忙先预览一下。一方面确认整体的阐述上显著的纰漏表达不清的地区,另一方面针对各样错别字,排版样式等进行最后的复核检测非常多时候我都会把文案在草稿箱里搁置个几天,瞧瞧过程中有显现有些新的修改完善想法,能够即时弥补,毕竟非常多平台发布之后就不准许大幅度的修改了。

发布与运营

最后便是把博客文案进行发布了,咱们能够选取的发布平台非常多,例如微X公众号,知乎,掘金,SegmentFault,简书,语雀,CSDN,博客园等,能够利用 Github 自建站的形式。因为日前平台选项的繁多,因此咱们通常不会直接在这些平台进行撰写,而是把撰写和发布“解耦”,在本地撰写文案而后选取区别的平台去导入发布,详细的操作会在后面的工具栈环节进行描述。日前我个人选取的平台是公众号和知乎,前者方便在伴侣圈做做推广和在手机上阅读,后者相对来讲社区质量还算比较高,能够大众一同交流学习,另一阅读体验上来讲比较清爽。倘若读者规模到了必定量级,自建站是一种不错的选取

另一便是对博客的推广运营了,这方面说实话我并不善于因此整体的关注者和阅读量都始终比较低迷。有些比较通用的运营办法包含文案中添加版权信息,历史文案的索引,在区别的社群和论坛做文案宣传,选取合适的时间段进行发布等。另一针对各个平台有自己专门的推广方式,例如知乎上能够选取关注量很强的问题来回答,相比写文案来讲天然流量会更大些。另外知乎供给了内容自荐等创作推广功能。而微X公众号则能够设置一系列的自动回复,自定义菜单,专题标签等,提高关注者的互动体验。

工具

最后一个部分,咱们结合上面的写作流程来介绍一下个人感觉比较舒服的一套工具栈。

选题与素材管理

这部分的工作,我通常采用待办任务和笔记的方式来进行,重点运用工具是 Notion。

针对选题,能够创建关联的任务来做管理。我针对自己的需求比较低,工作之余一月能产出一篇差不多就能够了……

素材方面,能够利用有些 Notion 模板来将看过的东西做归类记录,后续在写作时经过 tag 过滤来统一浏览。有些零碎的点能够直接记录在待办任务页面里。

Notion 笔记列表

文案撰写

主编辑器

为了在多平台进行发布,咱们能够选取相对通用的文本格式,如 markdown 来进行详细的内容撰写。初期尝试过有些专用的 markdown 编辑器,如 Typora 等,但后来发掘文案比较长,链接和照片比较多的时候,Typora 的性能显现非常多问题,非常影响写作体验。后续经过一番调研,选取vscode[10] 做为重点的编辑器。Vscode 的整体性能还是比较优秀的,几万字的文案编辑起来完全不会有任何卡顿。另一 vscode 的插件体系很强大,有一系列帮忙加强咱们撰写效率的工具,例如我个人比较爱好的 Markdown Image 来支持照片插进和自动图床同步,Pangu-Markdown 来做中文文本的自动格式化等。

云端同步

运用非常多在线平台都能够支持自动的云端同步,这般咱们能够区别的电脑上进行文案的撰写,不消担心电脑 down 机引起的内容丢失问题。不外 vscode 本身并这般的能力,因此咱们必须结合云盘来实现类似的功能。由于我购买了 Office 365 的订阅,因此顺理成章用了 OneDrive 来做为咱们的云同步服务。运用起来非常的简单,只要把关联 markdown 等文件存在电脑的 OneDrive 目录下就可,撰写过程中一旦有文件新增或保留,都会做自动同步。

另外倘若必须多人合作写一篇文案能够这里基本上再引入 git 来做代码同步。当然这个方法从实时性上来讲还是比不上非常多在线协同文档软件,但针对创作周期较长的文案来讲基本还能够接受。

Vscode + OneDrive

图床

前面有说到 vscode 的 Markdown Image 插件,其中就支持非常多区别的图床。运用图床而不是本地文件的好处在于,咱们后续上传到区别平台时,不会显现 markdown 中的图像链接解析不出来的问题,否则的话就得一张一张照片重新上传,工作量还是比很强的。图床服务本来想用七牛,但注册审核方面貌似比较麻烦,最后还是采用了更简单有些CODING[11] 来进行托管,而后在插件中配置一下 access token 基本就能够了,后续有任何想要插进照片,复制后运用快捷键 alt + shift + v 就可。当然照片本身我还是会在 OneDrive 的同目录下保留一份,以避免后续有云服务失效照片找不回来的问题。

备注:非常多在线笔记平台能够做到上面三个工具的全功能,例如语雀,Notion 等,因此直接运用这些平台理论上是可行的。但必须重视评定一下 markdown 导出之类的功能是不是完善,例如链接,代码,公式,照片各样格式信息的导出是不是完整且符合通用标准,避免后续显现难以迁移发布的困难。

绘图

非常多时候咱们必须自己绘制有些结构图来更好的阐述关联内容,之前我通常ProcessOn[12] draw.io[13] 这类相对正式有些的在线绘图工具。后来一个偶然的机会接触到了 excalidraw[14] 这个手绘风格的工具,就立刻被吸引住了。虽然供给的图形很少,但基本够用,况且效果特别有“个性”,挺适合博客这类非正式场合的配图的。另一它还有个优良能够运用快捷键,下面这个示意配图基本能够在 2 分钟之内快速搞定。

Excalidraw

有时候绘图中咱们期盼有些区别色彩的区分,通常来讲各样网站预置的色板都比较丑,咱们能够有些工具网站参考更现代美观的配色方法,例如 coolors[15]:

配色方法生成器

倘若代码内容不多,又对字体,排版有比较高的需求,还能够试试这个生成代码照片carbon[16]:

代码照片生成

发布

Markdown 排版

因为微X公众号有有些限制,例如不可外链等,通常在导入到公众号草稿前咱们必须有些排版工作。日前我用的网站是 markdown.com.cn[17],能够选取一系列模板,并做有些 css 格式上的微调。这个网站还能够一键把外链转成备注信息,这点尤其实用。倘若你正在微X公众号上读这篇文案,拉到最后就能看到效果

值得一提的是,微X公众号的文案编辑页面自带了错别字检测功能,我在发布到其它平台之前会用这个功能先做一下大致的检测

题图资源

区别网站在做发布时可能还必须有些额外的操作,标题,简介这些常规的还是比较好搞定的,不外题图这个就稍微有些难度了。我日前通常会直接在正文配图中挑选一张,Unsplash[18] 上搜索关联照片做为题图。非常多作者会根据必定的风格来进行自制,是不错的选取

自建站框架

倘若打算自建博客,那样能够用类似 hexo[19] 之类的博客框架来帮忙直接生成全部静态站而后能够直接安排在 Github Pages 上,连买服务器之类的都省了,相当方便。更繁杂有些的 wordpress 之类的我个人就尝试过了。

写在最后

写技术博客还是一个必须长时间保持的事情,工作之后断断续续写了这么些年,还是个技术小号。不外连续下来针对个人的技术累积,沟通表达能力的提高还是相当显著的。

参考资料

[1]

观远技术团队博客: https://www.zhihu.com/column/c_1473064639017254912

[2]

数据密集型应用系统设计: https://book.douban.com/subject/30329536/

[3]

资深工程师之路系列: https://zhuanlan.zhihu.com/p/410206677

[4]

pluskid 大佬的博客: https://freemind.pluskid.org/

[5]

大数据哪些事: https://www.zhihu.com/column/feizong

[6]

科技星辰: https://www.zhihu.com/column/c_1441815196541480960

[7]

算法工程师技术路线图: https://zhuanlan.zhihu.com/p/192633890

[8]

走马观花 AutoML: https://zhuanlan.zhihu.com/p/212512984

[9]

3B1B: https://space.bilibili.com/88461692

[10]

vscode: https://code.visualstudio.com/

[11]

CODING: https://coding.net/

[12]

ProcessOn: https://www.processon.com/

[13]

draw.io: https://app.diagrams.net/

[14]

excalidraw: https://excalidraw.com/

[15]

coolors: https://coolors.co/

[16]

carbon: https://carbon.now.sh/

[17]

markdown.com.cn: https://markdown.com.cn/editor/

[18]

Unsplash: https://unsplash.com/

[19]

hexo: https://hexo.io/zh-cn/





上一篇:评定女性卵巢功能的指标有哪些?对评定生育力有什么功效?
下一篇:小白入门水质模型,看这篇就够了
回复

使用道具 举报

3

主题

508

回帖

15

积分

新手上路

Rank: 1

积分
15
发表于 2024-8-28 15:10:37 | 显示全部楼层
i免费外链发布平台 http://www.fok120.com/
回复

使用道具 举报

0

主题

1万

回帖

1

积分

新手上路

Rank: 1

积分
1
发表于 2024-9-10 13:14:36 | 显示全部楼层
你的留言真是温暖如春,让我感受到了无尽的支持与鼓励。
回复

使用道具 举报

3047

主题

3万

回帖

9606万

积分

论坛元老

Rank: 8Rank: 8

积分
96065852
发表于 2024-10-13 16:30:15 | 显示全部楼层
这夸赞甜到心里,让我感觉温暖无比。
回复

使用道具 举报

3138

主题

3万

回帖

9996万

积分

论坛元老

Rank: 8Rank: 8

积分
99968624
发表于 2024-10-14 05:04:27 | 显示全部楼层
我们有着相似的经历,你的感受我深有体会。
回复

使用道具 举报

3061

主题

3万

回帖

9913万

积分

论坛元老

Rank: 8Rank: 8

积分
99139052
发表于 2024-10-20 17:36:27 | 显示全部楼层
论坛外链网  http://www.fok120.com/
回复

使用道具 举报

2996

主题

3万

回帖

9910万

积分

论坛元老

Rank: 8Rank: 8

积分
99109194
发表于 2024-10-26 01:52:57 | 显示全部楼层
一看到楼主的气势,我就觉得楼主同在社区里灌水。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

站点统计|Archiver|手机版|小黑屋|天涯论坛 ( 非经营性网站 )|网站地图

GMT+8, 2024-11-23 09:10 , Processed in 0.131908 second(s), 22 queries .

Powered by Discuz! X3.4

Copyright © 2001-2023, Tencent Cloud.