开发员完成项目后要求他写出开发文档???

来源:百度知道 编辑:UC知道 时间:2024/06/27 23:55:35
开发员完成项目后要求他写出开发文档???

一般大概写些什么的内容.
有相关的文档参考吗???
这没有分 开发前与后写吧...比如那些数据结构划分,设计视图等...
目的是让完成的项目在必要时候能让另外开发人员跟进.总不能一定开发本人才能改吧..

文档是开发之前就应该写了,包括概要设计、详细设计、测试报告等

只有严格按照软件设计开发流程才能开发出可靠易于维护的软件。
各个文档应当重点说明的是业务关系而非用了什么数据结构视图什么的。
概要设计是要说明你的软件包括哪些部分,这些部分应该有什么功能。
详细设计就是对那些功能的具体说明,比如软件界面什么样子,输入数据需要做哪些check,需要对数据做哪些处理,数据库表怎么设计的,通信电文各位的意义等等。总之开发人员只要拿到详细设计就能把程序作出来。
详细设计强调的是我要的是什么,而不是你该去怎么干,具体代码怎么编写那是编程人员的事。
软件开发讲究的是正确性扩展性维护性,如果我是客户我才不管你用什么技术,只要你能做出我想要得就行。

国外公司都是按照流程先文档后开发程序,其实编程时间占整个开发过程的时间是很少的。本人在国内公司待过在国外公司也待过,国内公司大家时间都花在编写代码上,代码编好了发现不对就改,改了发现还有问题再改,许多开发人员根本不清楚他们要做的东西到底应该是个什么样子,新的开发人员加入进来就更是一头雾水。国外公司如东芝非常注重文档的编写,各种设计书测试报告写的非常详细,对软件的任何修改都会在设计书上反映出来,新加入的人员只要对照设计书和代码很快就能接手项目。

在开发前写,在此对上楼大哥做补充,如果写洋细的话,包括你的开发进度,使用方法等!