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

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

本文档由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

智能推荐

分布式光纤传感器的全球与中国市场2022-2028年:技术、参与者、趋势、市场规模及占有率研究报告_预计2026年中国分布式传感器市场规模有多大-程序员宅基地

文章浏览阅读3.2k次。本文研究全球与中国市场分布式光纤传感器的发展现状及未来发展趋势,分别从生产和消费的角度分析分布式光纤传感器的主要生产地区、主要消费地区以及主要的生产商。重点分析全球与中国市场的主要厂商产品特点、产品规格、不同规格产品的价格、产量、产值及全球和中国市场主要生产商的市场份额。主要生产商包括:FISO TechnologiesBrugg KabelSensor HighwayOmnisensAFL GlobalQinetiQ GroupLockheed MartinOSENSA Innovati_预计2026年中国分布式传感器市场规模有多大

07_08 常用组合逻辑电路结构——为IC设计的延时估计铺垫_基4布斯算法代码-程序员宅基地

文章浏览阅读1.1k次,点赞2次,收藏12次。常用组合逻辑电路结构——为IC设计的延时估计铺垫学习目的:估计模块间的delay,确保写的代码的timing 综合能给到多少HZ,以满足需求!_基4布斯算法代码

OpenAI Manager助手(基于SpringBoot和Vue)_chatgpt网页版-程序员宅基地

文章浏览阅读3.3k次,点赞3次,收藏5次。OpenAI Manager助手(基于SpringBoot和Vue)_chatgpt网页版

关于美国计算机奥赛USACO,你想知道的都在这_usaco可以多次提交吗-程序员宅基地

文章浏览阅读2.2k次。USACO自1992年举办,到目前为止已经举办了27届,目的是为了帮助美国信息学国家队选拔IOI的队员,目前逐渐发展为全球热门的线上赛事,成为美国大学申请条件下,含金量相当高的官方竞赛。USACO的比赛成绩可以助力计算机专业留学,越来越多的学生进入了康奈尔,麻省理工,普林斯顿,哈佛和耶鲁等大学,这些同学的共同点是他们都参加了美国计算机科学竞赛(USACO),并且取得过非常好的成绩。适合参赛人群USACO适合国内在读学生有意向申请美国大学的或者想锻炼自己编程能力的同学,高三学生也可以参加12月的第_usaco可以多次提交吗

MySQL存储过程和自定义函数_mysql自定义函数和存储过程-程序员宅基地

文章浏览阅读394次。1.1 存储程序1.2 创建存储过程1.3 创建自定义函数1.3.1 示例1.4 自定义函数和存储过程的区别1.5 变量的使用1.6 定义条件和处理程序1.6.1 定义条件1.6.1.1 示例1.6.2 定义处理程序1.6.2.1 示例1.7 光标的使用1.7.1 声明光标1.7.2 打开光标1.7.3 使用光标1.7.4 关闭光标1.8 流程控制的使用1.8.1 IF语句1.8.2 CASE语句1.8.3 LOOP语句1.8.4 LEAVE语句1.8.5 ITERATE语句1.8.6 REPEAT语句。_mysql自定义函数和存储过程

半导体基础知识与PN结_本征半导体电流为0-程序员宅基地

文章浏览阅读188次。半导体二极管——集成电路最小组成单元。_本征半导体电流为0

随便推点

【Unity3d Shader】水面和岩浆效果_unity 岩浆shader-程序员宅基地

文章浏览阅读2.8k次,点赞3次,收藏18次。游戏水面特效实现方式太多。咱们这边介绍的是一最简单的UV动画(无顶点位移),整个mesh由4个顶点构成。实现了水面效果(左图),不动代码稍微修改下参数和贴图可以实现岩浆效果(右图)。有要思路是1,uv按时间去做正弦波移动2,在1的基础上加个凹凸图混合uv3,在1、2的基础上加个水流方向4,加上对雾效的支持,如没必要请自行删除雾效代码(把包含fog的几行代码删除)S..._unity 岩浆shader

广义线性模型——Logistic回归模型(1)_广义线性回归模型-程序员宅基地

文章浏览阅读5k次。广义线性模型是线性模型的扩展,它通过连接函数建立响应变量的数学期望值与线性组合的预测变量之间的关系。广义线性模型拟合的形式为:其中g(μY)是条件均值的函数(称为连接函数)。另外,你可放松Y为正态分布的假设,改为Y 服从指数分布族中的一种分布即可。设定好连接函数和概率分布后,便可以通过最大似然估计的多次迭代推导出各参数值。在大部分情况下,线性模型就可以通过一系列连续型或类别型预测变量来预测正态分布的响应变量的工作。但是,有时候我们要进行非正态因变量的分析,例如:(1)类别型.._广义线性回归模型

HTML+CSS大作业 环境网页设计与实现(垃圾分类) web前端开发技术 web课程设计 网页规划与设计_垃圾分类网页设计目标怎么写-程序员宅基地

文章浏览阅读69次。环境保护、 保护地球、 校园环保、垃圾分类、绿色家园、等网站的设计与制作。 总结了一些学生网页制作的经验:一般的网页需要融入以下知识点:div+css布局、浮动、定位、高级css、表格、表单及验证、js轮播图、音频 视频 Flash的应用、ul li、下拉导航栏、鼠标划过效果等知识点,网页的风格主题也很全面:如爱好、风景、校园、美食、动漫、游戏、咖啡、音乐、家乡、电影、名人、商城以及个人主页等主题,学生、新手可参考下方页面的布局和设计和HTML源码(有用点赞△) 一套A+的网_垃圾分类网页设计目标怎么写

C# .Net 发布后,把dll全部放在一个文件夹中,让软件目录更整洁_.net dll 全局目录-程序员宅基地

文章浏览阅读614次,点赞7次,收藏11次。之前找到一个修改 exe 中 DLL地址 的方法, 不太好使,虽然能正确启动, 但无法改变 exe 的工作目录,这就影响了.Net 中很多获取 exe 执行目录来拼接的地址 ( 相对路径 ),比如 wwwroot 和 代码中相对目录还有一些复制到目录的普通文件 等等,它们的地址都会指向原来 exe 的目录, 而不是自定义的 “lib” 目录,根本原因就是没有修改 exe 的工作目录这次来搞一个启动程序,把 .net 的所有东西都放在一个文件夹,在文件夹同级的目录制作一个 exe._.net dll 全局目录

BRIEF特征点描述算法_breif description calculation 特征点-程序员宅基地

文章浏览阅读1.5k次。本文为转载,原博客地址:http://blog.csdn.net/hujingshuang/article/details/46910259简介 BRIEF是2010年的一篇名为《BRIEF:Binary Robust Independent Elementary Features》的文章中提出,BRIEF是对已检测到的特征点进行描述,它是一种二进制编码的描述子,摈弃了利用区域灰度..._breif description calculation 特征点

房屋租赁管理系统的设计和实现,SpringBoot计算机毕业设计论文_基于spring boot的房屋租赁系统论文-程序员宅基地

文章浏览阅读4.1k次,点赞21次,收藏79次。本文是《基于SpringBoot的房屋租赁管理系统》的配套原创说明文档,可以给应届毕业生提供格式撰写参考,也可以给开发类似系统的朋友们提供功能业务设计思路。_基于spring boot的房屋租赁系统论文