技术写作,首先是写作,其次才是技术。
如果只关心技术,直接看代码不就得了。读者读技术文章,就想通过作者的解读,更轻松地搞懂代码,或者掌握某项技术。今天,咱们就来聊聊怎样用简练的文字,让技术文章更抓人。
咱们先聊聊“炼字”吧。举个例子看看:
- 别老用“一个”。比如这句话:“我转型成了一个技术创作者。”改成“我转型成了技术创作者”,意思没变,但更简洁。要是还想更简练,就说:“我转做技术创作。”
- 去掉多余的“的”,句子立刻利落起来,试试看吧!
- 少用“是...的”结构,让句子更简洁。
接下来,聊聊“炼句”。在技术写作里,短句比长句更能吸睛。所以,多用短句,让文章读起来轻快易懂。
还有,遣词造句也很重要。有些英文短语译成中文后,意思可能不清楚。比如,“end to end”可以换成“一揽子”或“全功能”,这样表达更明白。
那怎么构建自己的知识体系呢?首先,定方向、选主题,从浅入深,一步步来。然后,每天学习、坚持分享,打造自己的知识网。最后,持续进步、乐于助人,让知识体系越来越强大。
最后,推荐两本好书,《文章自在》和《修辞概要》。《修辞概要》的作者是张志公,新版本再版叫《作文基本功:如何写得生动有趣》。这两本书都能帮我们提高技术写作水平。
好啦,一起开启这场轻松愉快的写作之旅吧!你会发现,技术写作其实也可以很简单、很有趣。最重要的是,享受这个过程,让文字和技术都活起来!