首页 > 代码库 > 文档总结(一)——文档的概述
文档总结(一)——文档的概述
写完文档后,本来想写一篇具体的文档的总结的,后来看大家都写的具体文档总结,于是我就想:我还是写一些跟大家不一样的东西吧。
所以,我就说说我对各个文档的宏观理解吧。
老规矩,先来一张图:
这是我们的文档,也可以说这是软件的前半生。它包括了我们的软件的从计划——设计——实现——测试的过程,至于之后的维护,估计是没有算在软件开发的文档里面,不过可以肯定的是绝对会有文档的。
文档是一种交流的方式,也是一种工作的证据,往好了说,文档便于团队去开发软件;往坏了说,软件就是一种证据,人家需求上写了,你的软件上没有实现该功能,那就是你软件开发的问题。
那么,各个文档主要到底都写了些啥呢?又是写给谁看的呢?
先是计划阶段,这个阶段总共会产生两个比较重要的文档:可行性分析和软件需求说明书。
先说可行性分析,这个文档的作用是判断你的开发项目是否可以开发,由项目开发人员,或者是专门的做可行性调查的公司来写的一个文档。可行性分析报告一般写给公司的领导,由领导批准后,才可以开始项目。
这个文档主要通过软件的投资、收益、风险、法律等方面研究本项目开发会不会获得利润,最后给出一个该软件是否可以开发的报告。ps:说白了,这个文档的作用就是给老板写个开发本软件有啥好处的文档。便于老板做决定是否开发该软件。
老板决定要开发软件后,就需要进一步的研究即将开发的软件:这个软件都需要实现一些啥功能呢?客户对软件有啥要求呢?
这就是需求说明书需要解决的主要问题了。软件的计划阶段的最后的产物就是需求说明书了,特别容易理解,需求说明书,肯定是说软件的需求的。
需求说明书一般应该由系统分析员和客户一起写,如果分工细一些,就应该由需求分析员来写,通常是系统分析员写后让客户确定。需求说明书即是写给用户看的,又是写给团队看的。客户、领导、项目组成员以及合作公司等等和项目相关的人几乎都需要知道项目的需求。ps:需求说明书其实就是问下客户,你需要个什么样的东西,然后将用户的需要记下来,留着以后需要的时候看。
好,系统分析结束后就该软件的设计阶段了,设计又分为概要设计、详细设计和数据库设计。
概要设计:概要设计是依据需求说明书,将软件的结构、软件的模块、模块的层次、模块的关系、每个模块的大概功能描述出来的文档,应该是由系统分析员(归设计组组长管理)去写这个文档,作为软件整体的大概描述。PS:感觉就像是问路一样,概要设计给出的回答是:XX家在XX村,而XX村是属于XX镇的。
详细设计:详细设计说的是具体的功能实现,说出了软件都有哪些具体的功能。是对概要设计的一个细化,就是详细设计每个模块实现算法,所需的局部结构。ps:详细设计给出的回答是:去XX家的话,你要先左拐,到路口右拐,到下一个路口再左拐、、、
考虑到篇幅问题,接下来的文档说明请看软工总结文档(二)。
文档总结(一)——文档的概述