写点什么

总结:我在技术写作中踩过的 6 个坑

  • 2023-12-17
    北京
  • 本文字数:1186 字

    阅读完需:约 4 分钟

总结:我在技术写作中踩过的 6 个坑

Hello,大家好!我是 Java 工程师蔡姬,此蔡姬非彼菜鸡!很高兴在这里和大家分享自己的观点和经历。


今天继续学习《21 天技术人写作行动营》课程内容,今天的主要内容是如何写正文以及技术文章写作的一些踩坑点。内容有很多细节,但总结一句话就是,一切为读者着想。


作为一名在技术领域摸爬滚打,饱经摧残的写作者,我的写作之路充满了坎坷,可谓处处是坑,当然,这些也都成为了收获,这得益于经常的反思和总结。所谓“学而不思则罔,思而不学则殆”,说的就是这个意思。


今天借完成《21 天技术人写作行动营》作业的机会,总结一下之前写技术文章的时候踩过的一些坑,为后续的文章输出赋能。话不多说,今天,你打卡了吗?!

1. 避免错误的完美主义

在刚开始写技术文章的时候,我总是试图追求完美。每一句话、每一个段落都经过反复雕琢,但其实技术文章和艺术类题材不太一样,有时候准确清晰的表达比追求优美的语言更重要。自己所谓的完美主义可能并不会帮助到读者,当然,对文章本身内容的高标准要求还是必须的。

2. 缺少配图

在之前写文章的时候,我没有太关注图片的重要性,一方面,我认为我已经用文字表达出来了;另一方面,作图确实会花费大量的时间。但随着经验的积累,我发现为一些内容添加配图是很有必要的,这会在极大程度上降低读者的理解门槛,节约读者的时间,另外,高质量的配图会为文章本身的质量大大增色。

3. 缺乏真实示例

在起步阶段,我常常会选择一些基础的示例来作为演示,而不是真正的线上环境中的示例,但读者对这种示例远没有对线上实际的示例敏感,示例的价值也就难以得到体现,因此,我后来总结出,还是要尽量使用真实案例,这样对读者更有帮助。

4. 排版有待提高

我以前没有发现排版对线上文章有多么重要。直到我的读者跟我反馈,读我的文章有点费眼睛,我才恍然大悟。排版不需要多么花哨,但起码要清晰整洁,重点突出,才能给读者更好的阅读体验。意识到这个问题后,我开始使用加粗、斜体或颜色等方式标记关键信息。并注意标题和正文的字体大小,段落之间的空行等等,这些虽然与文章内容本身无关,但对读者来说,却很重要,它有点像商品的包装,一个优质的商品可能会因为包装太丑而无人问津。

5. 自嗨,读者 get 不到

文章和笔记不同,文章是写给读者看的,这一点认识对于刚刚写文章的人很重要。不要想怎么表达自己更爽,而是多想想怎么表达读者更爽。避免自嗨和自我感动,读者才是真正的用户。

6. 缺少运营和正向激励

过去写文章的时候,没有意识去主动引导读者深入讨论,也缺乏正向激励。这带来的问题就是缺少迭代的过程,只能凭着自己的想象去写,去输出,而且随着时间的流逝,也容易失去动力,难以长期坚持。这也是接下来我要重点关注的点。

小结

内容 + 包装 + 运营 + 正向激励,才能把技术人写作这件事完成闭环。


欢迎你在评论区分享你踩坑的经历,我们一起探讨,共同进步!我是 Java 工程师蔡姬,期待和伙伴们有更多的交流和思维碰撞!

发布于: 刚刚阅读数: 6
用户头像

还未添加个人签名 2020-07-28 加入

还未添加个人简介

评论

发布
暂无评论
总结:我在技术写作中踩过的 6 个坑_技术人_Java 工程师蔡姬_InfoQ写作社区