只接受发布货源信息,不可发布违法信息,一旦发现永久封号,欢迎向我们举报!
1064879863
16货源网 > 餐饮行业新闻资讯 > 软件开发 >  软件开发文档重要么,什么方法可以让开发人员在完成好项目的同时,提交相关文档?


软件开发文档重要么,什么方法可以让开发人员在完成好项目的同时,提交相关文档?

发布时间:2019-05-19 06:24:35  来源:网友自行发布(如侵权请联系本站立刻删除)  浏览:   【】【】【
这个,基本上。。。很难
软件开发文档重要么,什么方法可以让开发人员在完成好项目的同时,提交相关文档? 这个,基本上。。。很难 有一些文档是非常重要的,数据库的设计文档,涉及到不同系统的接口设计文档,一些复杂系统的编译安装文档。这些个是比较重要的,应当要保留下来。 第一个问题,软件开发文档很重要,需求文档、数据库设计文档、模块接口说明文档,不论项目大小,这几个文档也都是必须的。不能说它能够发挥多大的作用,只能说有了它们更有利于项目按期、高效率完成。
第二个问题,我个人认为让所有参与开发的人员写文档不大可能。文档的作用就是能够让大家在开发中有文可依,做一个参照和了解业务及实现原理、流程。不说不能写,只是怕写的只有写的人自己能够理解,而其他开发人员却看不懂。与其这样不如在团队中安排一个相对文采较好,并参与整个项目需求分析、架构设计、编码实现的开发人员撰写。 redmine很好的项目管理软件,开源很好用结合subversion书写刚刚好的文档,避免补文档,我刚好有篇文章讲这个话题,参见 Just enough(刚刚好)的软件开发文档什么样?
http://blog.csdn.net/zhangmike/article/details/6786503我之前接触过的团队有不写需求文档的,也不能是说不写!...他们把所有的功能描述和说明 全部写在AXURE原型里了,这个怎么说呢,看团队之间的配合来决定了,如果开发团队,一开始就不写开发文档,你现在想去修改别人的习惯,挺难的,这个时候需要你的个人影响力 去决定
要看是什么规模的软件项目。
大规模,超大规模 的项目,并且历时很长,需要协同开发的项目。没有文档的话简直是不可想象的。
中小规模,且发布后很少有修改的需要的话,不如把更多的精力放在代码自注释上,详细设计文档没有也罢。

既然很重要,那么怎么能够让开发人员很好完成呢?我的看法是无利不起早。一定要为文档编写预留出充裕的时间,并且纳入绩效考评。其次,如果可能的话,要对详细设计文档进行审批,做到文档先行。审批不一定要多么正式,以小组讨论的形式展开效果也很好。软件开发文档的作用(写文档的目的):整理思路;统一认识;以备维护。写不写设计文档应从能否提高团队开发效率角度考虑,如果不需要文档也能保持沟通顺畅,那就不写,小型的敏捷开发过程就是这样。如果团队规模较大,周期较长(中间会有人员变更),那就应该写文档。应该去帮助开发人员写文档(比如提供合适的模板、例子,很多开发人员语文水平远远差于代码水平),而不是一味的去提要求。
少些点文档就好了。所有的东西最后都是垃圾一堆,少写点更环保。软件开发文档实现不是很难,不是不可能,不是随意。
关键取决于 企业一贯作风习俗,高管态度,用户是否要求。

至于必要性,答案是必要。但未必拘于形式。
文档的作用是让大家对项目结构、对逻辑有共同的、统一确定的认识。

这就是为什么产品设计、开发、测试如果都是一个人来做的小项目,不需要文档。安排一个有技术背景的,文字、总结、记录能力比较强的文档工程师,专门配合项目经理及开发人员整理、编写文档。程序员的烦恼之一 写文档

程序员的烦恼之一 缺少文档开始不做,后面在来写,就十分十分的抠脑壳!每周更新下文档,每天查看下 注释,但是如果开发周期紧张的话,这些会败给时间推荐ABT软件工程文档生成工具。文档写作效率提高百倍!如果您开展的项目多,这就是降维打击工具。

ABT软件工程文档生成工具,规范文档样式结构,快速生成: 1需求规格,2设计说明,3测试报告,4用户手册,5用户联机帮助,6其他文档。
用户自己写文档核心内容,即自动或定制生成插图,uml图(用例图,结构组成图,功能类图,类包图,数据类图,流程图等),表格,章节目录,顺序编号,列表项段落等等。
版本管理十分方便,支持合并、导入,文档模块化、重用性非常好。

根据需要增加功能,定制模版。可生成word,powerpoint,pdf,html,htmlhelp等常见文档。

建议上一套毕升文档协作和管理系统,相当于 GoogleDocs + Box,团队成员直接在线编辑共享Office文档(以后会支持画Visio图,表单等更多文档类型),既能及时共享项目信息,又能自动沉淀项目相关文档。

对于团队规模大,或者成员地域分散的团队尤其节省沟通成本。

官网:https://ibisheng.cn

责任编辑:
热门阅读排行
© 16货源网 1064879863