”文档写作能力“ 是软件开发工程师必备的素质之一!_文档编写能力举例说明-程序员宅基地

技术标签: 工作|学习|生活心得  

本文档由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. 如何提高文档写作的能力:

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

智能推荐

oracle 12c 集群安装后的检查_12c查看crs状态-程序员宅基地

文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下:http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态:[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态

解决jupyter notebook无法找到虚拟环境的问题_jupyter没有pytorch环境-程序员宅基地

文章浏览阅读1.3w次,点赞45次,收藏99次。我个人用的是anaconda3的一个python集成环境,自带jupyter notebook,但在我打开jupyter notebook界面后,却找不到对应的虚拟环境,原来是jupyter notebook只是通用于下载anaconda时自带的环境,其他环境要想使用必须手动下载一些库:1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境

国内安装scoop的保姆教程_scoop-cn-程序员宅基地

文章浏览阅读5.2k次,点赞19次,收藏28次。选择scoop纯属意外,也是无奈,因为电脑用户被锁了管理员权限,所有exe安装程序都无法安装,只可以用绿色软件,最后被我发现scoop,省去了到处下载XXX绿色版的烦恼,当然scoop里需要管理员权限的软件也跟我无缘了(譬如everything)。推荐添加dorado这个bucket镜像,里面很多中文软件,但是部分国外的软件下载地址在github,可能无法下载。以上两个是官方bucket的国内镜像,所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn

Element ui colorpicker在Vue中的使用_vue el-color-picker-程序员宅基地

文章浏览阅读4.5k次,点赞2次,收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了,例如:这里的:sty..._vue el-color-picker

迅为iTOP-4412精英版之烧写内核移植后的镜像_exynos 4412 刷机-程序员宅基地

文章浏览阅读640次。基于芯片日益增长的问题,所以内核开发者们引入了新的方法,就是在内核中只保留函数,而数据则不包含,由用户(应用程序员)自己把数据按照规定的格式编写,并放在约定的地方,为了不占用过多的内存,还要求数据以根精简的方式编写。boot启动时,传参给内核,告诉内核设备树文件和kernel的位置,内核启动时根据地址去找到设备树文件,再利用专用的编译器去反编译dtb文件,将dtb还原成数据结构,以供驱动的函数去调用。firmware是三星的一个固件的设备信息,因为找不到固件,所以内核启动不成功。_exynos 4412 刷机

Linux系统配置jdk_linux配置jdk-程序员宅基地

文章浏览阅读2w次,点赞24次,收藏42次。Linux系统配置jdkLinux学习教程,Linux入门教程(超详细)_linux配置jdk

随便推点

matlab(4):特殊符号的输入_matlab微米怎么输入-程序员宅基地

文章浏览阅读3.3k次,点赞5次,收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图:_matlab微米怎么输入

C语言程序设计-文件(打开与关闭、顺序、二进制读写)-程序员宅基地

文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件,可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中,对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数,而关闭则使用fclose函数。在C语言中,可以使用fread和fwrite函数进行二进制读写。‍ Biaoge 于2024-03-09 23:51发布 阅读量:7 ️文章类型:【 C语言程序设计 】在C语言中,用于打开文件的函数是____,用于关闭文件的函数是____。

Touchdesigner自学笔记之三_touchdesigner怎么让一个模型跟着鼠标移动-程序员宅基地

文章浏览阅读3.4k次,点赞2次,收藏13次。跟随鼠标移动的粒子以grid(SOP)为partical(SOP)的资源模板,调整后连接【Geo组合+point spirit(MAT)】,在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in(CHOP)鼠标位置到metaball的坐标,实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动

【附源码】基于java的校园停车场管理系统的设计与实现61m0e9计算机毕设SSM_基于java技术的停车场管理系统实现与设计-程序员宅基地

文章浏览阅读178次。项目运行环境配置:Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX(Webstorm也行)+ Eclispe(IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持)。项目技术:Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成,B/S模式 + Maven管理等等。环境需要1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计

Android系统播放器MediaPlayer源码分析_android多媒体播放源码分析 时序图-程序员宅基地

文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多,会从Java-&amp;amp;gt;Jni-&amp;amp;gt;C/C++慢慢分析,后面会慢慢更新。另外,博客只作为自己学习记录的一种方式,对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析 时序图

java 数据结构与算法 ——快速排序法-程序员宅基地

文章浏览阅读2.4k次,点赞41次,收藏13次。java 数据结构与算法 ——快速排序法_快速排序法