代码与文字

640?wx_fmt=jpeg

题图 from unsplash

代码与文字

做技术的,写代码自然不在话下,但你说写个设计文档、做个技术总结分享什么的,可就把一部分人难倒了,理由是没写过、没思路、写不出来、文笔不行等等。当然不要抬杠:代码也是文字。

你是不是有这种情况?有没有绞尽脑汁、硬着头皮凑字交差的经历?相信绝大部分技术朋友都有这样的窘境吧!

先说回技术人之间的沟通问题,沟通分大类:口头沟通和书面沟通,口头沟通最常见的形式有电话交流,培训交流,面对面讨论,组织会议等。书面沟通形式有邮件、书面汇报、PPT、各种软件文档等。口头且面对面的交流沟通是效果最好的,但有个缺点:不能留存口头讨论的结果,事后不久就忘了当时讨论的内容、结论等,基本无从追溯,特别当相关各方涉及利益问题时,免不了要有会议纪要,备忘录、正式合作文件等等。

理论上讲代码逻辑写的没有问题,那你的文字的表达能力应该也没有问题,唯一的原因大概只是欠缺训练。分开讲:训,偏向于理论概念方向;练,偏向于实践操作方向,两者结合才能完美。文字都是抽象思维里的具像化,并在具体的场景以不同的形式展现出来。想象一下,如果一个开源组件缺少文档的话,会是一种什么状态,还会流行吗?除非很好用,自然会有人主动为其增加文档,来方便后来者学习掌握。如果代码里没有注释,这对维护者简单就是噩梦,所有需要有一些文字、图表等等来方便人们更加快速的掌握其中的奥秘。

比如说去做软件设计的过程中必然有一些核心或者是复杂度比较高的业务,必须付诸于图、表或文字,来加速、加深干系人对它的掌握理解,以便于实际的编码过程中保证业务不走样。你是不是会遇到这样的场景:去跟某个技术人员去交流学习某块的业务,他让你去看代码,理由里代码里写的清清楚楚?如果是个不懂行的人跟你交流业务问题,还能代码来搪塞,估计要说不过去了。能用图表说清楚的尽量不用文字,能用文字说清楚的尽量不依赖代码,形象化的东西总是容易被人记的深刻。

写作技巧是有,简单掌握下即可,其实程序员的日常文档也就那么多,能表达意思即可。比如概设、详设、存储设计、核心流程图、开发计划、接口设计、架构设计、物理部署等等,完全可以数的过来。都说写代码的没有写PPT的薪水高,这是个表象,另一个层面也说明写PPT更多的面向非技术人员去沟通交流,比如上级领导、老板、客户等等,另一个也说明人的资历在提升,打交道的人际范围在扩大。从业时间越久,越需要你一定的文字功底,不然跟多个干系人沟通起来都是问题。跟高层汇报总不能拿空口白牙大白话吧,跟兄弟们作分享,总不能拿代码比划吧,去外面做技术交流,总不能打包IDE看代码吧。

说这么多,主要是想传递一个信号:不要逃避写文档,何况很多都有参照模板,往里套东西总不至于太难吧。写文档有利于自我总结提炼、抽象提升、积累沉淀,加深对技术、对业务的理解,更有利于不同领域的人之间交流沟通,事后追溯查阅等等。其实所有这些,目标还是只有一个:更高的提升自我,不管是薪水职位,还是个人成长。

写文字的好处有很多,找一个点说服自己,行动起来。凡事,有必要的,都要学着来。

比如我写文字可以找到志同道合的朋友,结交生活中不可能认识到的一些人,这就是写公号文章的副产品,时间久了,能够形成体系,更加的有价值。

640?wx_fmt=png

 往期推荐:

长按2秒,识别二维码,关注我

640?wx_fmt=jpeg

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MavenTalk

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值