技术布道与技术文档写作

前几天我的某位博客读者给我发了一封邮件,表示了一番感谢,因为他在看到我的某篇技术文章后,顺利解决了某个一直困扰他的问题。说真的,这事儿让我很开心,因为我感受到了技术布道的乐趣。

非IT行业的同学,是不是觉得这篇日志的标题怪怪的?啥是“技术布道”?好吧,请容我先解释一下。Evangelist原本是有宗教含义的“传道士”,只是后来这个词的使用情景被泛化了。例如一个极力推崇开源软件的人,到处宣扬开源的好处,不遗余力地做各种推广,这种人你就可以称其为开源世界的“布道者”,很形象是吧?这里举的例子,就属于本文提到的技术布道范畴(可参考维基百科对Technology evangelist的定义)。

严格来说,我不算一个真正意义上的Technology evangelist。因为其实我没啥技术……虽然我的Job Title是Technical Writer,我真的不懂多少技术,连编程也不会(好吧,Python倒是断断续续学了一段时间了)。不过呢,自打从接触电脑起,我就很热衷于学习各种网络知识,写各种小教程,和身边的人分享心得。我做的这一切,初衷很简单:我们活在这个技术高度发达的时代,就应该享受技术带来的好处。所谓独乐乐不如众乐乐,自己学到了东西,分享给其他人,让大家也能享受技术带来的好处,这不是一件很好的事么?

在实际生活中,我能影响到的人毕竟是很有限的:同学、朋友、同事……。于是我选择了写博客,希望有更多人能够看到我写的东西,从中获取某些知识为己所用。这个博客也会有一些非技术性的文章,偶尔发发牢骚煽煽情什么的,但我尽量控制其比例,把精力集中在技术性的文章上。毕竟,我又不是什么明星,没有人会对我今天吃了啥,心情如何之类的话题感兴趣,对吧。我不敢保证自己写的每篇文章都是精品,但至少,我会尽量避免让读者看了之后,有种“这纯粹是废话,浪费了我好几分钟”的感觉。

前面提过,我是一个Technical Writer(技术文档工程师)。很难说,到底是因为我在工作之前就喜欢写软件教程,从而在机缘巧合之下选择了这个职业,还是说,因为这个职业,我更喜欢写软件教程了。技术非常好的人,有很多,可是有能力将技术细节以非常通俗的方式写出来,传播给广大读者的人,不多;再说了,即便技术人有这个写作能力,人家也不一定有这个意愿(“写文档什么的最讨厌了”)、有这个时间(“我很忙的……”)。在前公司的last day,我发出的告别邮件中,提到了这么一个冷笑话:

程序员有两个不喜欢:1)写文档;2)别人不写文档。

可见,写文档,特别是写技术文档这事儿,从来都不是观众喜闻乐见的事儿。很多人都没有阅读技术文档的习惯,可是等到碰上问题了,找不到答案,就只能乖乖地去查文档了。这个时侯,要是连文档都查不到,恐怕就会骂娘了。

Twitter中文圈红人西乔(@arthur369),曾在其某篇博客中持这么一个观点:

“如果这是一篇能对更多人有用,有价值有必要写的文章, 但你还是不愿意去组织表述,不屑于让非专业不够高级的读者看懂,那就不是大牛风格,而是傲慢。”

我自然不是什么大牛,所以呢,认认真真地写好每一篇技术文章,无论是工作上的,还是自己的博客,这是应该的。再有空的话,就积极点,向大家“洗脑”,传播一下技术的好处,多好玩啊。

你,感受到了么?

“技术布道与技术文档写作”的6个回复

    1. 别这么想,你觉得自己是小白,但永远有比你更小白的人需要这些信息呀。不过话又说回来,如果某个话题简单地百度或者Google一下就能找到大量详实的资料,那你大可不必重复造轮子。要么开辟新的话题,要么在旧话题上发掘出新的内涵。

  1. 感受到了~真的感受到了~ 读了您好几篇关于技术写作的博文,收获很多!我也是一名英文技术文档工程师 🙂 很高兴也很幸运能看见同行/前辈们分享的经验总结!会持续关注你的博客的~~

发表评论

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