关于技术写作过程的思考与总结

序言

2024.4.14日腾讯云+社区组织了一次关于技术写作的交流,参与分享的嘉宾需要到北京与网友进行线下的交流。本次交流我也是提前一周才接收到的邀请,开始还是犹豫了一下是否要去,犹豫的原因是不知道说点什么,但最后经过考虑再三还是应邀了,因为我觉得首先对话题确实比较感兴趣,同时也是提升自己一个不错的机会。
行程回来后,我整理了所思、所想、所感分为以下几个部分介绍,希望能给大家做一个借鉴

(PS :云+社区地址有奖写作传送门:https://cloud.tencent.com/developer/article/2408033

一 材料整理

本次邀请的话题是关于“技术写作”话题,我本人是非常喜欢写作的,但此话题还是非常泛,所以还是要找到一个切入点。本次一共会邀请四位老师来分享,事前看各位老师的话题都是以“怎么”开头,所以最终我的题目为《怎么让写作助力你的职业发展》。

1.1 关于分享的话题

关于写作话题我想了很多,我的想法还是希望结合我日常接触最多的事的总结,以话题的形势分享出来。 而工作中可能接触比较多的、日报、周报、月报、半年总结等,他们背后的写作逻辑是什么样,如何能表达更清晰,而把这些写作逻辑整理出来,应该更好的帮助我们工作中涉及写作的内容,也就引出了我要分享的内容《怎么让写作助力你的职业发展》。

1.2 话题结构

分享最重要的是受众群体,我从组织者那也有大概了解,所以大概思路还是抛砖引玉的方式,从我个人说起,当时分享话题结构如下:

  • 写作结缘
  • 写作方法
  • 写作案例
  • 写作工具

关于分享的ppt,可以访问:https://qcloudimg.tencent-cloud.cn/raw/8abeef6c6623c19303fe6b474e1931b2.pdf

1.2.1 写作的结缘

关于写作我从自己的兴趣说起,在2000年左右就有中美黑客大战的新闻,当时我非常仰慕黑客,所以在上高中时就购买了很多黑客相关书籍如黑客X档案、黑客防线,后来发现很多书提及了Linux/UNIX,于是上大学的时候开始学习,但发现Linux学习起来还是非常费力的,主要是命令太多比较难记忆,譬如Linux有300+命令,假如每个命令的参数平均为5个,那就是至少1500个需要记忆点,所以我从记录学习笔记、在技术论坛回复贴开始,后来发现写的笔记多了是可以整理为成体系书籍的,于是就写了《Linux企业级应用》,但这书籍并未上市,但却让我有了写一本证书书的念头。

时间的推移工作后有出版社的朋友看到我写的博客联系到我,问是否有意愿出一本书,而我当时正在用Puppet解决我工作中遇到的问题,回想起我学Linux的经过就很快的答应了,最终出一本正式书籍《Puppet权威指南》。 答应很爽快但实际写作过程还是比较痛苦的( 这本书2014年出版,关于书更详细见:https://blog.puppeter.com/2014/09/08/page-2/ ) 但结果还是收获非常大的,这也是我和写作结缘的开始。

1.2.2 写作的方法

手里有锤子看什么都像钉子,对写作有兴趣的话,会发现工作中事儿都可以作为写作的话题。譬如解决问题的过程、思路和方法。

在工作中我们通常解决的就是问题或一类问题,举个例子,譬如A产品年成本是120万,到年底我们要下降到60万,要解决这个问题我们应该如何应对?首先就是可行性分析,也许可以下降60万也许还能比这下降更多,一旦确定目标并确认可行,剩下就交给时间了,我们可以通过周报、月报、定期汇报来跟进起来。 以这个为案例我们来聊一下关于解决一个工作中问题的写作的方法。

解决一个问题或一类问题的大体思路
写作开始前,我们脑海里要有个大体的思路,如图:

首先脑海里要问这几个为什么?

  • 问题是什么: 准确的定义问题就相当于解决了问题的一半
  • 目标是什么
  • 现状是什么: 目标 - 现状 = 差距,再用5W2H方法
  • 5W2H:为什么做、要解决相关问题依赖人、什么时间做完、怎么做计划是什么

在脑海中大概解决这些疑问,那么解决问题的轮廓就已经出来了,写作时我们也可以把这些思考落到笔头写到总结中。

大处着眼,小处着手
在解决问题前,首先我们要有一个全局视图,也就是“大处着眼,小处着手”,意思是说做事前先全局看,等真要做时再去动手做,特别在写作、汇报、沟通表达时,很容易加深对方理解与记忆。

如图举个例子试想一下,譬如我介绍动物,先说他有四只脚,但是有四只脚的动物很多,所有要反过来先全局说,再聊细节,容易让人理解与记忆。

结构化你的案例
在解决问题时,通常我们会列举一些案例,目的是加深别人对事情的了解、共同推动解决问题,所以这里案例表述就要注意逻辑顺序:

  • 结论先行: 描述问题时先说结论是什么,譬如A产品下降成本60万,需要A产品做策略调整,需要依赖A产品的哪个同事具体做什么事。 (顺带说一下,结论先行最开始,应该出自美国南北战争,那时刚发明发报机,因为字数有限,要先说重点和结论,最后说问题的这种结构,提高沟通的效率)
  • 案例不要超过三个:案例要有优先级、时间先后的排序
  • 事物推演分为演绎与归纳:写作中尽量用归纳法

以上更细节内容大家也可以参考《金字塔原理》 。

一图胜千言
介绍案例时在写作或汇报场景,最好多用图来表述,譬如:

  • 介绍产品,要有个产品架构图
  • 介绍系统,要有个系统架构图

平日也要多收集一些意思的图,在后续写作时都可以使用。

1.2.3 写作案例

关于写作案例这里,我更想表达在分享过程中一定要言之有物,笔者分享了写作的方法和注意事项,最后需要通过案例套用一下刚说的方法,做到言之有物。

以下是笔者最近在整理的一篇文章《如何做客户至上的产品体验》,也应用了刚刚提的很多方法。如“大处着眼,小处着手”,写作前先要整理目录结构的这些方法。

可能目录有些长,说一下目录的思考,这里源于我问自己的三个问题基础上不断的延展而来,这三个问题是:

  • 如何做产品体验?
  • 如何解决体验类的问题?
  • 如何预防体验类的问题?

关于此案例更多细节后续我会发布到博客上,因为还没完全结稿这里就不再细说。

1.2.4 工具 && 书籍

本次分享每个人为30分钟+10分钟答疑,主办方分享的目的更多是让嘉宾抛砖引玉,所以在最后笔者也会推荐一些书籍和协作工具,如截图。

1.2.5 总结

总结是为了加深人的印象,我们在写作时,如果写的过长每章建议都要小结一下,如果是汇报写PPT也要定期的总结。

总结思路
关于本次分享,我总结的思路从拆分写作这事儿说起,其实写作分为三个部分、输入、加工和输出(如以下截图) ,每个环节的一些方法。

点题
总结的最后,还是要去点题一下。 我的分享话题是《怎么通过写作助力你的职业发展》 其实写作是职业发展中的重要一环节,但职业发展中更重要的是能把解决的问题有结构的说出来,并最终解决它,正如那句话“思想就是武器,能说才是活力”。

二 现场演讲

通常在职场写作的目的是将解决问题过程有结构的表达出来,从这角度看写作应该是个里程碑,终点是如何表达并解决问题,而表达又分为很多场景可以锻炼提升,演讲就是其中之一,所以开篇也说了为什么来,这也可以锻炼我的现场表达能力。

本次云+社区的邀请会前,其实我只问了一下受重群体其他了解并不多,到现场才发现座位就有180个,同时有直播线上网友也可以看到,顿时感觉云+社群的影响力还是很大的。

放平日这种分享并没有太多的压力,但在一个陌生的人群中来分享还是会感到有些压力,以下分享关于演讲过程的思考。

2.1 演讲前

PPT整理好后,首先就是要反馈的练习,一些不常用的术语,譬如我在分享时介绍了5W2H这个方法,要展开介绍什么是5W2H,如何应用。 同时还要找一个观众视角的同学来试着分享一下PPT看一下他的感受;最后,我个人常用的方法也是把自己演讲的ppt生成录音,反复在耳边播放两次加深自己的记忆,缓解紧张情绪,其实最后这一点对我个人来说还挺试用的。

2.2 演讲中

暖场
暖场在每次分享时也是非常重要的。 因为本次我是最后一位分享嘉宾,当天分享的话题都是写作,其实也难免会和前面分享嘉宾内容方法上有冲突,这里在分享前我也特意说了一下,通过这做个暖场或与上一位分享嘉宾的转场,否则直接讲自己的内容会有一些僵硬。

如何不紧张
分享时我边上做的老师,关注到他不断在看手机分享的ppt内容,确实临阵磨刀不快也光,但每个人都有自己的方法,我方法是降自己的低预期,我希望自己能把所有内容有逻辑顺序的表达出就好,反复的看有可能会带来紧张的情绪,所以我和边上分享嘉宾是相反的。

还有就是演讲过程中尽量的放慢语速,适当回想大纲、目标和本节重点内容是否都讲清,转移自己的注意力缓解紧张情绪。

演讲质量
上场后下面人比较多,最好关注某一部分的听众,关注他们的表情是否能听懂,如果不断地点头说明还是能听懂或有收获的,如果大部分只顾看手机,可能要思考一下,如何讲的更有趣一些吸引观众。

三 会后感受

用一句话总结“一个周日的下午、100多人的会场、有着兴趣相同的人、一起在一个会议室里聊有兴趣的话题,这种感觉还是非常棒的”。回顾这次分享,我对以下这个问题印象比较深刻

很多人关注写作的变现
有几位分享嘉宾分享后,也能听到很多人在问变现的问题。 我觉得是一个比较有意思的问题,从我认知角度来看写书、把工作干好是可以变现的。当然没有人问我这个问题,假如有人问我,我要说写书能变现,出过书的人就会一笑(技术类书籍不赚钱,但可以锻炼自己的写作能力)。如果读者你看到这里,有什么建议也可以给我留言沟通探讨。

最后,关于写作这个话题,平日的积累要很重要,在我印象中每个嘉宾都提及了大量的随机阅读,当然这里推荐的是方式是阅读经典、如孔、孟、老、庄、中庸、大学等,我曾在微信读书看过,有的不太好理解,只是留下了一个印象,当有一些生活或工作经历后,你再回溯这些经典会非常深刻的学到古人总结的道理,最后希望腾讯云云+社区越办越好,给社会带来更多价值。

相关参考
如何做一场分享:https://blog.puppeter.com/2022/10/30/page-40/