我们为什么要写技术文章呢?在工作中如何沉淀出技术文章呢?如何写好一篇技术文章呢?相信通过这篇文章你可以得到答案。那么我们开始吧。

前人栽树,后人乘凉。在日常开发和运维工作中,开发人员往往会借助大量的手段学习、分析、解决问题,比如:官方文档、开源社区、技术博客和公司内部论坛等。

通过写作技术文档、技术文章,可以在技术圈子传递和分享自己对一个技术的认知和经验总结,接受反馈、相互学习,加强对技术的探讨和升华。通过他人技术文章解决问题的同时,我们也应该学会反哺。

一篇实用的技术原创文章,可以为自己带来大量的读者,可以发掘和提高个人包含技术在内的能力,大幅提升个人的影响力。

写作对个人的专业水平和综合能力是有一定的门槛的。正所谓技多不压身,除了基本的编程开发能力,开发人员还应该具备一些其他技能:

:擅于学习新的技术,总结规律、形成自己的学习体系和知识库,对任何新技术都能快速上手、举一反三和融会贯通。

:学而时习之,由于技术和知识体系过于庞大,需要定期进行总结和归纳,形成自己的知识备忘录,加深对技术的理解。

:将线上疑难杂症的分析解决能力以文档、博客的方式总结,方便后续遇到同类问题时能够快速分析、定位和解决。

万事开头难,技术写作也是一样,通常迈出第一步是最难的,这个阶段的核心是突破自己内心的障碍。这时的障碍主要来自两方面:

明确定位文章的面向群体,面向初级、中级、高级、TL 还是技术总监,内容高度是有很大区别的。不同岗位、不同职级的人本身对文章层次的需求相差甚大,并不是高度越高就越好。

首先可以明确不是带着批判的心态,其次他们可能也希望通过文章去补充自己,看看是否有新观念、新想法的出现。即使不符合他们的胃口,比如讲的内容自己可能做得更好,他们会很快关闭去看其他的,而不是继续浪费时间。当然,还有一种可能,他们可能并不会打开。总之,这方面也没有什么可顾虑的。

不积跬步无以至千里。要写出高质量的文章,需要不断地积累素材和总结经验,最后通过文字表达出来。先说下积累和总结,这个分积累素材和系统总结:

在日常学习和工作中,要养成记录随笔的习惯,随时记录一下自己对技术的理解和思考,也包括工作实践中的踩坑避雷的经验总结。这个过程不限于阅读、收藏他人的好文章、提炼出核心的技术知识点,并对素材和知识点进行标记和归类。

当某项技术的收藏和记录知识素材积累到一定程度时,你对技术的理解和认知也会达到一定的广度和深度。当你在工作中应用到这项技术,将理论基础和实践中的技术方案、技术调优和数据支撑相结合,融入工程化实践和自己的观点,最终将知识结构化和文档化,就形成了一篇高质量的文章。

在日常工作中哪些内容可以沉淀为技术文章,我们得先清楚哪些内容是可以产出技术文章。

你遇到过的线上技术问题和难题,一般是某个具体的技术点(bug、性能、生产事故等),经过你的分析、排查和处理,问题得到了有效解决,解决后你又系统性地学习和研究了相关技术知识,即可总结为一篇文章。

你在工作中为解决某个业务问题,通过分析、调研和验证等环节,产出的设计方案,及其使用到的相关工具、框架或组件等,可总结为一篇文章。

你关注的行业发展中出现的新技术、新趋势,能提高解决问题的效率、带来更好的实践或能够有效突破现有技术的瓶颈等,可总结为一篇文章。

你参与过的某个项目,为了按时高质量的交付,遇到的一些挑战(问题、风险等),可以是技术方面的挑战,也可以是沟通协作的挑战,或者是工作模式的挑战,都可以总结出经验和教训。

你在写代码、调试、测试和运维等阶段,发现了好用的工具、技巧或规范,能够提高工作效率、代码质量等,也可总结为一篇文章。

你学习的编程语言、技术框架的学习笔记(梳理、总结等)、实践经验(Demo 代码、实际应用),可总结为一篇文章。

好记性不如烂笔头,写作不是一个作者的专职工作,日常工作和学习有很多锻炼的方式,对于程序员来说有哪些方式呢?

在日常开发工作中,写好代码注释也是一种好的手段。如果你的代码写得足够优秀,是不需要过多注释的,注释是对代码的一种理解的增强。

对于复杂业务场景、公共代码库以及晦涩难懂的代码,清晰的注释可以帮助其他开发人员快速理解业务上下文和代码逻辑。

回复简书、掘金、知乎、51CTO、CSDN、博客园和思否等平台上他人提出的问题。

在 Github、Stack Overflow、官方技术平台等平台提出、回答问题。

在微信公众号、简书、掘金、知乎、51CTO、CSDN 和博客园等平台发表技术文章。

在 InfoQ、51CTO、阿里开发社区等官方技术平台刊登杂志、技术博客。

利用 Gitbook、Docsify、VuePress 和语雀对某个技术领域进行长期的知识沉淀。

在公司内部 Confluence Wiki、WPS 文档和公司代码仓库编写技术文档。

对某个技术领域有了深入和系统的学习、理解和思考,有了成系列的技术文档、技术博客以后,就可以考虑出版技术书籍的可能。

如果需要出版技术书籍,要先了解市面上同类书籍的内容,确定出版书籍针对的方向、侧重点、独特性。主要的出版社如下:

ProcessOn是一款专业强大的作图工具,支持多人实时在线协作,可以用于在线绘制流程图、思维导图、UI原型图、UML图、网络拓扑图、组织结构图等。ProcessOn 只能支持 9 张免费在线图片存储,支持多种格式的图片文件导入导出,能够兼容不同的操作系统,不管是 Mac 还是 Windows,一个浏览器就可以完成画图工作。

你可以利用它绘制一系列的图表、图示或图形,包括流程图、UML类图、组织结构图、泳道图、E-R图、文氏图等,适用于商务、工程、电气、网络设计、软件设计等诸多领域的专业绘图。它致力于成为完全开源、免费、并且高质量的绘图软件。

软件内置了相当丰富的绘图资源,包括各类形状、图标、连接器、模板,能满足绝大大多数的绘图需求,还可以导入第三方图标资源满足更多需求,完全可以取代微软 Visio 等流程图软件。

Excalidraw是一款非常轻量的在线白板工具,可以直接在浏览器打开,轻松绘制具有手绘风格的图形。Excalidraw 基于Markdown语法实现绘图功能,不仅简洁轻量,还可以和 Markdown 编辑器的工具集成,实现各种特色功能。

好的文章需要好的封面,有条件的可以自己画,也可以用一些工具来生成,比如创客贴、稿定设计等,也可以是任意的图片。

创客贴是一款简单易用的线上图形设计神器,功能十分强。

By admin

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注