”文档写作能力“ 是软件开发工程师必备的素质之一!

版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/inter_peng/article/details/80301603

本文档由Markdown语法编辑器编辑完成!

1. 概述:

不知不觉中,从刚毕业时的毛头小伙,到现在的油腻中年程序员,已经过了将近五年了。在这五年中,做过的项目,大小加起来也有十几个了吧,写过的代码量5万行应该差不多了吧。在这五年的工作过程中,除去软件开发能力的提升,系统和软件架构能力的扩展外,越来越让我感觉重要的,就是可能被大部分程序猿和程序媛们忽略的能力——文档写作能力!

这里的文档,包含的种类特别多,在第二节中会详细介绍一下。

然而,不管是什么样的文档,我们首先要明确的重要一点就是:文档是写给别人看的。 不管你想以什么样的风格和格式来写,最终这篇文档的阅读者,90%的可能性是别人,这个别人,有可能是你们部门的同事,你们产品的客户,软件审核机构的工作人员,你离职时交接工作的同事等等。

有很多的程序员,不太喜欢写文档,或者根本没有这个意识去写文档。在我看来,”写文档”不一定非得是领导给你安排写文档的任务后,你才想起来去写文档。而是应该,当你接到一项调研、开发任务或测试任务,你觉得这项工作,未来可能会有别的同事要参与进来,那么你为了节省自己的时间, 不用对于每一个新同事你都重新讲一遍过程,你就可以把你写好的文档直接发给他。先让他读一下文档,然后遇到问题的话,再来和你沟通,那么沟通的质量会大大提升。

就像写作文的能力是需要不断积累才能提高的,写文档的能力也是需要通过不断地撰写才能提高的。一个人不可能过去从来没有写过一篇像样的文档,就突然灵感爆发,写出一篇高质量的文档。这个认知,我也是通过订阅得到APP里面的专栏,在阅读很多牛人的专栏时他们透露的,每一天专栏作者为了准备更新专栏需要付出的努力,才深刻体会到的。

例如,得到《5分钟商学院》的专栏人刘润老师,为了准备更新每天5分钟的专栏文章,都需要付出2~3个小时,有时候甚至是4~5个小时的时间。这倒不是由于这些老师的能力低,无法一蹴而就写好专栏文章。而是因为他们对自己的要求极其严格,为了写作300~400字的文章,他们可能会先写出3000~4000字的初稿,然后再去粗取精,逐字逐句死磕,然后才编辑出最终的稿件,然后还要交给APP专栏的编辑,再进行一轮的审核校对,方能被读者看到。以至于,像罗永浩这样的牛人,曾经在得到APP上开了讲解他创业故事的专栏,然后由于每天占用的时间大大超出了他之前的预估,不得已而停止了专栏的更新,并向APP和广大的读者致歉。

还有一位科技界的大牛,也是我的偶像吴军老师,他多次在得到专栏《硅谷来信》中提到,写作能力是国外大学非常注重培养的能力之一。不管这个学生在大学学习的是什么专业,写作课是他们的必修课。而吴军老师也是身体力行,他把自己平时工作和生活中的思考都及时地用文字记录下来,先是在Google黑板报中以专栏的形式发表“数学之美”,等到积累到一定程度后,整理成书,以《数学之美》一书出版,让科技界的人士对于数学这门科学上的王冠的学科有了重新的认识。翻看《数学之美》中的每一篇文章,无不是吴老师工作中的积累与思考,如果他不以文字的形式记录下来,那么我们会遗憾地错过这么卓越的文章。而后,吴军老师又把自己对于硅谷公司的沉浮,以《浪潮之巅》一书出版,之后又相继出版了《文明之光1~4》,《大学之路(上,下)》,《智能时代》,《见识》等等。吴军老师对自己的要求是,每做一项工作,都以科研的方式进行,等待工作完成,便会以论文的形式将他的工作进行文字整理。吴军老师现在也已经是科技界最炙手可热的人物了。

“厚积薄发”这个成语是我经常提到的。每一个成功人士的背后,都一定有许多常人看不到的努力。唯有不断的积累,才有可能实现由量变转化为质变。任何一个成功的作家,他们扔在废纸篓里的草稿也一定比他们发表的作品还要多。因此,我们也应该有信心,更要有恒心,才有可能写出优秀的文档。

以下具体总结一下,工作这五年来接触过的文档类型,好让大家了解一下软件工程师的工作内容,可不光是每天对着电脑写程序,其实有很多时间也是开着office在写word或者做ppt呢!

2. 文档类型:

3. 如何提高文档写作的能力:

展开阅读全文

诚聘软件开发工程师(上海)

08-06

诚聘软件开发工程师(上海)rnrn我们现在有一批手机游戏需要进行移植/开发,特招聘以下全职员工:rn如果有意,请发简历至 bbmf@isresource.com,我们会很快和您取得联系rn在简历中请说明薪金待遇,如有可能,也请说明您目前的薪金待遇,谢谢。rn切勿站内回文rnrn1.Senior Software Engineer 高级软件开发工程师 (2人)rn 要求:有深厚的c/c++,java 开发功底rn 有开发过移动设备 游戏/应用程序 的经历rn 熟悉J2MErn 熟悉BREW是另外一项加分rn 设计过游戏引擎是一项加分rn 有过在C语言与JAVA之间作转换的经历是一项加分rn 有组织能力,能协调团队成员进行开发rn 工作描述:rn 带领开发团队完成所给定任务,进行游戏的移植/开发rn rn2.Software Engineer 软件开发工程师(5人)rn 要求:有深厚的c/c++,java 开发功底rn 有开发过移动设备 游戏/应用程序 的经历rn 熟悉J2MErn 工作描述:rn 进行游戏的移植/开发rn rn3.Information Consultant 游戏开发信息顾问(1人)rn 要求:由敏锐的观察力,搜集相关资料协助开发团队完成开发rn 熟悉流程设计的软件工具rn 工作描述:rn 搜集开发所需要的相关资料rn 并给开发团队提供建议 rn rn4.Graphical Designer 美术设计工程师(2人)rn 要求:有深厚的美术功底rn 熟练使用各种图形图像开发工具,如PHOTOSHOP,3D MAX.....rn 能按照游戏策划所给定要求制作出精美的图片rn 工作描述:rn 制作游戏图片rnrn5.Translator 翻译(1人)rn 要求:熟悉韩语rn 工作描述:rn 翻译工作过程中的一些文档 论坛

没有更多推荐了,返回首页