网站地图
联系我们

    湖北隆德专用汽车制造有限公司

    销售经理:程克友

    销售热线:13872881933

    销售电话:0722-7502768

    图文传真:0722-7502768

    在线客服:

    邮箱:[email protected]

    地址:湖北省随州市经济开发区季梁大道9号

    • 龙虎国际娱乐【畅言】法式员既要写好代码又要写好文档

    • 更多   
    • 作者:张大丽
    • 发布时间:2017-09-09 02:35
    • 新闻浏览热度:

      龙虎国际娱乐平台比来,CSDN正在举办“2014 CSDN博文大赛”勾当。我看本次勾当中的一些参赛做品层次清晰、文笔流利、言语漂亮,大都出自法式员之手。我不由想到一个问题:法式员能否该当沉视文档的编写?

      对于软件相关行业,正在学校或单元大师也许都曾经留意到了,除了要编写的法式、绘制设想图之外,还有一个主要的工做即是写文档。为什么要写文档呢?由于我们要把本人做的工具展现出来,不但展现给同业看,可能还要展现给其他岗亭上的工做人员看,以至展现给用户看。若是我们只是会写法式,不会正在文档中得当且文雅地描述本人的设法,那么就实正的成为“码农”了。

      我留意了一下,四周的同事会写高质量文档简直实很少。李开复教员正在《海潮之巅》的序言中说到:“我认识良多顶尖的工程师,但具备强大叙事能力的优良工程师,我认识的能够说是凤毛麟角。”确实,我所认识的同事,可以或许正在文档中清晰地表达本人设法的也很少。

      我们每天城市收发良多邮件,我细心看了一下,良多邮件里面的内容要么语句欠亨畅、要么有良多错别字、要么误用或没有标点符号。良多时候,从分歧的角度理解,一封邮件有良多分歧的意义,让人感受不晓得它事实要表达一个什么意义,如许极大地降低了工做的效率。

      正在项目小组会商的时候,大师几乎都正在说如何把法式写好,而没有提到正在文档书写方面应若何勤奋去改良。大师似乎分歧认为开辟人员的职责就是把法式写好,其它什么的都是其次的。

      相关计较机软件的保守定义为:软件是计较机系统中取硬件相依存的另一部门,软件包罗法式、数据及其相关文档的完整调集。留意,这里面就提到了“相关文档”,若是文档没有写好,那么软件也不克不及算是优良的软件。现实上,软件功能健全,而因为文档缘由呈现毛病的环境还时有发生。

      可见,正在软件的分歧阶段,需要编写分歧的文档。正在打算阶段,需要编写细致设想文档、单位测试方案文档和集成测试方案文档等;正在开辟阶段,也是这几个文档,不外是修订版,由于我们正在现实开辟过程中,会发觉之前设想不合理的处所或者是考虑不周的处所,这就需要对之前的文档进行点窜;正在测试阶段,要编写单位测试演讲、集成测试演讲和系统测试演讲等;正在软件的发布阶段,要编写安拆手册、用户手册、升级指点书等,这些文档次要是面向现场支撑人员和用户的,因而要尽量写得通俗易懂,万万不要有含糊其词的环境存正在,不然就只要期待用户的赞扬了。

      对于邮件的编写,要把本人想说的话精确地表达出来,正在发送邮件之前,再看一下内容能否完整、能否还有错别字、语句能否通畅等。

      正在编写文档的过程中,要严酷参照项目组的模板来完成。正在写完文档之后,对文档进行语法查抄,以改正错别字和有语法错误的处所。一般说来,有语法错误的语句下面会有一条绿色的海浪线。正在提交文档之前,再一下整个文档,看能否还有疏漏和不脚。

      正在工做之余,能够读一些可以或许提高言语表达能力和写做能力的册本或文章,看一下别人是如何清晰地阐述本人思惟的。例如,经常阅读CSDN优良博从的博文就是一个提高本人写做能力的好法子。

      总的说来,和做其它工作一样,书写文档也反映了一小我的立场问题。写出高质量的文档,不只能够提拔小我的抽象(若是你看到一篇好文档,是不是也对做者有较高的评价?),还可以或许提拔产物正在客户心中的抽象。如斯阐发,多花些心思来书写文档实的是很有需要。

      要想做好一件工作,需要我们从各个方面来勤奋。正在开辟软件的过程中,写好代码很主要,清晰了然地正在文档中表达本人思惟同样很是的主要。“代码”和“文档”就像是一小我的左膀左臂,必然要让两者平衡成长,而不成以或许只顾其一。

      周兆熊,沉庆潼南人。2009年7月结业于海南大学通信工程专业,2012年4月结业于南京邮电大学计较机使用手艺专业,获工学硕士学位。现正在中兴通信股份无限公司沉庆研发核心处置软件开辟工做。微博:周兆熊,微信:245924426。

      《畅言》第十二期:【[】软件工程基于思维承载之物的特质,必然会有清晰的合用鸿沟。但现实上恰好取此相反,每当一种工程方式出生避世的时候,它的感化老是潜正在的有扩大的趋向,似乎一旦锤子正在手之后,所怀孕边的工具就都变成了应锤一锤的钉子。

      《畅言》第十三期:【[畅言]法式员的成功能否有纪律可循?】天然界中存正在很多纪律,那么正在法式人生上能否有纪律可循呢?这种纪律是如大大都人期望的那样吗?V众投倡议人李智怯对此进行了切磋,他阐发了必然取偶尔、素质取细节,并就法式人生纪律的三要素进行领会读。

      《畅言》第十四期:【[畅言]公司应不应当法式员上彀?】应不应当员工上彀?这虽然是个其傻非常的问题,但仍然有公司去实践,特别是做保守软件、外包、电信的更容易选择切断。如许无非是两个缘由,一个是消息平安,一个是但愿提高效率。然而其所来的风险很大。

      《畅言》是CSDN新栏目,供大师畅所欲言。只需你看完CSDN文章或评论后有话说,都能够通过电子邮件(),从而获得上CSDN首页表达本人概念、设法的机遇。《畅言》不怕概念“雷人”,只需你逻辑表达清晰、数据援用靠得住,你敢,我们就敢首页!欢送大师畅所欲言。

    本文网址:

关于我们

产品系列

服务中心

销售经理:程克友  13872881933  联系电话:0722-7502768  图文传真:0722-7502768  
业务QQ: 企业邮箱:[email protected]    湖北隆德专用汽车制造有限公司 公司地址:湖北省随州市经济开发区季梁大道9号

Copright © 2012-2020 http://www.pivoint.com All Rights Reserved.