程序员如何优雅的写技术文章?
hi, 大家好, 我是徐小夕, 新的一年, 你又复盘了吗?
当然今天不是分享 「技术干货」 的, 作为一名写了两年多技术文章的 coder, 今天和大家分享一下我写技术文章的一些方法和技巧, 同时也分享一款超级好用的面向技术人员写作的工具 「mdnice」.
我会从以下几个角度来和大家探讨如何写出一篇逻辑顺畅, 结构清晰, 样式美观的技术文章, 如果恰巧你对技术复盘和技术写作有一些疑问, 也希望这篇文章能对你有所帮助.
我们写技术文章的初衷是什么?
在写技术文章前, 需要准备什么?
技术文章写作神器mdnice使用介绍
文章发布后的“用户视角”
我们写技术文章的初衷是什么?
坦诚的说, 我在18年底开始写文章时, 单纯的是为了总结一些学到的知识, 以便在后期工作和面试中可以游刃有余. 所以那个阶段主要是以总结为主, 用 hexo 搭建了自己的技术博客, 写了很多 css, javascript, vue 的文章.
由于之前喜欢捣鼓 H5 游戏, 所以学习了很多算法, 也做了一些小游戏, 比如:
抽奖大转盘
拼图小游戏(拼拼乐)
canvas验证码
等等, 并通过文章的方式记录了我设计这些游戏的思路和方法. 现在回头来想这应该算是 「兴趣驱动」 吧~
再往后的一年里, 由于工作经验的增加和阅读了大量技术书籍, 我逐渐发现了很多业务上的需求, 比如 「CMS系统」, 「组件系统」, 「微前端架构」等, 所以就花了大量时间研究这些实现方案, 陆陆续续也做了对应的开源项目, 所以自然也有了我19年文章的内容基础.
这个阶段主要是从 「实际需求」 出发, 来提供解决方案的技术复盘, 所以19年到20年一直在写前端工程化, 组件化等的文章, 这个阶段也是我进步最快的时间段. 在掘金和知乎也获得了很多粉丝(这也许是技术创作者最好的回馈).
在20年到21年, 因为有一定的粉丝基础, 通过持续的学习和文章创作, 获取了一定的收益和社区影响力, 也先后多次受邀分享了低代码和可视化的技术实践.
综上, 从我的技术写作经历来说, 「作为技术人, 写作的初衷首先应该是由内而外的, 先要有兴趣或者一个对自己来说非常迫切的诉求, 然后再来考虑写什么, 怎么写.」
在写技术文章前, 需要准备什么?
我早期的文章也是过程式的, 想到哪写到哪, 做到哪写到哪. 首先这样做对自己或者他人来阅读或者理解其实成本还是挺高的. 比如说我需要把文章仔细的看完才知道它讲的是什么.
和编程也是一样的, 「面向过程的编程」明显从可维护扩展的角度劣于「面向对象的编程」. 就比如我们早期封装的 jquery 插件, 我们看到它名字就知道它是做什么的, 而且使用起来成本非常低, 可读性也很高.
所以, 在写作之前, 除了要知道自己要写什么之外, 还要有一个基本的 「写作大纲」. 我目前基本每一篇文章都会先写文章大纲目录, 如下:
滑动验证码文章大纲
从零搭建可视化大屏文章大纲
从零设计H5编辑器文章大纲
以上几个文章大纲大家可以参考一下. 我的统计结果是, 「有清晰大纲且内容逻辑清晰的文章阅读量普遍比早起面向过程式的文章阅读量高」.
当然, 最重要的还是要 「言之有物」.
技术文章写作神器mdnice使用介绍
这个普遍看脸的时代, 文章当然也要看颜值喽~ 这里给搭建推荐一个我常用的写作工具——「mdnice」.
它通过我们程序员最熟悉的 md 语法来写文章, 同时支持多个主题模版, 可以轻松帮我们渲染不同风格的文章样式, 让我们的文章更有颜值~
以下是我用 mdnice 写文章的界面:
大家感兴趣也可以尝试一下, 这里分享一下 「mdnice」 的地址:
https://product.mdnice.com/
文章发布后的“用户视角”
文章发布后的“用户视角”, 主要思想是关注「有效用户」的用户反馈. 因为写文章大多是站在自己的立场和角度写的, 无法避免一些疏漏或者错误, 所以始终以一种虚心的态度面对用户或读者的反馈, 才能让你越走越远.
当然, 本文也欢迎用户随时反馈, 各位有好的建议, 也可以在下方二维码中反馈:
好啦, 今天的分享就到这啦, 如果文章对你有帮助, 欢迎 「点赞」 + 「在看」, 鼓励作者创造更优质的内容~
点个在看你最好看