最懂技术的传播者,最懂传播的工程师。
《技术写作什么鬼》是由本人策划的一个关于技术写作的系列分享。
为什么会产生这个想法?
一方面,做技术写作培训的想法由来已久;另一方面,由于本人工作关系,平常需要非常密切对接到各个部门的研发同事——芯片研发、硬件研发、驱动软件研发、系统研发、工具研发、算法研发……我滴个神呐——沟通文档开发工作事宜,想尽一切办法,提升文档输出质量。那么问题来了——如何更有效率地传递技术写作的经验,提升质量基线呢?
作为一个职业TCer,解决这个问题,基本上属于“分内之事”。所以很自然地,我决定,把自己所掌握的技术写作地经验,陆续整理成文,与大家分享。
由于个人经验所限,这个课程主要面向IT领域的技术人员,着重解决大家在工作过程中可能遇到的写作问题。但实际上,对其他领域的朋友,只要你对技术写作感兴趣,或许也能多少有一些参考的价值?毕竟,写作的原理是共通的。
那么,作为《技术写作什么鬼》系列的第一篇文章,就让我们来聊聊,什么是技术写作?有什么用?跟我们的工作和生活,有什么关系?
什么是技术写作?
技术写作,是一个舶来的词汇,相应的英文表述是Technical Writing。不过,咬文嚼字地拽概念,终觉寡淡。技术写作与一般写作,究竟有什么差别呢?
一提到“写作”,大家会联想到什么?记录生活,表达观点,文学创作……其实,在日常的生活、学习、工作中,有一个非常重要的应用场景:高效沟通。
通常,直觉上我们想到的沟通方式,是面对面的交流。但是,这种方式存在很多问题:
信息量有限:不可能不计时间成本地,无限制地交流下去。
信息不够精准:大量口语化地表述,造成表意模糊,甚至误解。
信息难以深入:无法通过图表等辅助形式,简化信息复杂度,尤其是专业壁垒较高的信息,只能做浅层次交流。
所以,当遇到团队写作,或者1对多的场景时,就需要考虑借助写作,提升沟通效率,进行大规模的深度交流。
沟通时,我们不需要事无巨细的记录,不需要言辞犀利的表达,也不需要天马行空的创作,需要的,是重点突出、简洁精确的信息传递——于是,便有了技术写作。
技术写作跟我们有什么关系?
技术写作,广泛应用于日常的生活、学习和工作的方方面面。
比如,我们去政府部门办事,需要预先准备哪些材料,经过哪些流程,才能够完成?通常,我们可以通过阅读相关说明和指导,解决这些问题;比如,我们通过写作论文,向导师介绍自己的设计思路,和实验成果;比如,我们在单位向领导汇报项目进度和风险。类似的场景,简直不要太多,但又不仅限于此;比如,在专业领域打造一个个人IP。
提升技术写作能力,可以更有效地获取/传递信息,这不仅帮助我们更好地融入社会生活、提高学习/工作效率,甚至还可以扩大个人影响力。
如何提升技术写作的能力?
技术写作从不缺乏实践机会,只是很多人并没有意识到。所以,只需要有意识地学习技术写作技巧,加以反复练习,必然可以获得提升。
【TC研修实验室】的《技术写作什么鬼》系列,将分享技术写作的技巧和经验,并同步更新到知乎号,有兴趣的朋友,尤其是IT领域的攻城狮们,赶紧关注起来吧?
其他推荐:
实施:GitHub + MarkDown 文档系统的工作环境部署及工作流程说明 | 技术传播
这次他们说好要“讲真的” | 传播
在座都别吵了,你们还有我 | 技术传播
睿齐
技术传播从业者
品牌内容策划
自由摄影师
自由撰稿人
汪力迪
公众号:techcomm / htstory
微信号:bgrichi
邮箱:hash_0813@163.com