【软工文档】总结

原创 2016年08月29日 16:15:13

前言

              马上就要结束软工文档的学习,现在做一个小结,希望对相关知识有更清晰的了解。

正文

组成?

       软件开发文档共包括13个。分别为:
1.可行性研究报告
2.项目开发计划
3.软件需求说明书
4.概要设计说明书
5.详细设计说明书
6.数据库设计说明书
7.数据要求说明书
8.测试计划
9.测试分析报告
10.项目开发总结报告
11.操作手册
12.用户手册
13.开发进度月报

为什么要学习写文档?

         用最简单的话来说就是因为重要!百度百科中这样定义:“软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。”
         我们都知道软件是什么,但我们却常常忽略文档的重要性。文档是软件产品,没有文档的软件,何谈软件产品。文档贯穿于整个软件的生存周期,对各个阶段产生不同的作用,好的文档可以极大提高开发者的效率,也会使维护者的工作更高效。它可以把开发过程中发生的事件以可读形式记录在文档中,方便管理人员对软件开发的工程管理,也方便管理人员、开发人员、操作人员、用户之间的协作与交流。

产生于哪个阶段?如何分类?

            文档的产生与软件的开发有密切的关系,文档产生于软件开发的哪个阶段呢?

           这是以软件生存周期的几个阶段为标准进行分类,如果按照文档的产生和使用的范围,可划分为以下三大类:

预期读者是谁?

          编写文档之前,我们必须明确文档的预期读者是谁?文档是做给谁看的?

         从中我们不难看出,读者不同,需求分工也有所差别,但工作也有共同之处,所以分工协作很重要!

编写的目的?主要内容?

1.可行性研究报告
    说明该软件项目在各种综合因素下的可行性,包括经济、社会、技术、法律等因素。
    主要内容包括对现有系统的分析(处理流程和数据流程、工作负荷、费用开支、人员、设备),所建议的系统(说明、改进之处、影响、局限性)以及投资效益分析。
2.项目开发计划
    为软件项目的实施方案制定出具体的计划,方便相关人员根据本计划开展和检查本项目的开发工作。
    主要内容包括项目的概述(人员、产品、验收标准...),实施计划(任务分解与人员分工、进度、预算、关键问题)等。
3.软件需求说明书
    使管理人员和用户双方对软件的初始规定有一个共同的理解。
    主要内容包括任务概述、需求规定(功能、性能...)以及运行环境的规定(设备、支持软件、接口、控制)。
4.概要设计说明书
   主要目的是为详细设计说明书提供基础。
   主要内容包括总体设计、接口设计、运行设计、系统数据结构的设计、系统出错处理设计。
5.详细设计说明书
   主要描述系统的具体实现方法。
6.数据库设计说明书
   对数据库的设计方法作出具体规定。
   主要内容包括外部设计、结构设计、运用设计。
7.数据要求说明书
   对具体数据做出规定和要求。
   主要内容包括数据的描述(静态、动态输入、动态输出、内部生成、约定)、采集。 
8.测试计划
    提供对软件的测试计划,主要指组装测试和确认测试。
    主要内容包括测试进度安排、条件、资料、培训...
9.测试分析报告
   对测试结果进行分析,得出结论。
   主要内容包括测试概要、结果、对软件功能的结论、分析摘要、资源消耗。
10.项目开发总结报告
      对开发的整个过程做一个总结,对关键方面进行评价,得出一些经验教训。     
11.操作手册
     提供给用户,方便用户使用该软件。
12.用户手册
     提供给用户,方便用户使用该软件。
13.开发进度月报
     及时向管理人员汇报项目开发的进展和情况。
     主要内容包括进度、资额耗用、经费支出以及下月计划。

小结

              每写一篇博客,都可以对近阶段学习的知识有个更深刻的、全面的理解,越来越发现总结的重要性!
版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

[总结]软工文档验收

软工文档验收,师傅对我的文档提出了很多需要注意的地方,这里与大家分享一下!

《软工文档》总结

首次接触文档,一开始写时,感觉不知道如何下手,就看原文档,按着原文档写,写了几个后,就感觉有点思路了,发现写文档的思路大同小异。以下是我对文档的理解与总结。 首先:弄清楚该文档产生于软件开发的哪个阶...

软工文档——总结

软工文档【总结】 文档有很多的作用,为用户和程序员提供了一个可靠的依据。文档明确规定了各自的职责。 文档 目的 读者 《可行性研究报告》 项目开发人员、开发人员、系统维护人员 ...

软工第一遍文档总结

通过看软工视屏对软件工程有了较为宏观的认识,这两天又趁热打铁按照国标软工文档的要求尝试对之前进行的机房收费系统写了第一份软工文档。个人感觉还是有很多模糊的地方,甚至说是理解错误的地方,不过第一遍也就先...

软工总结——写文档真的重要吗?

今天晚上师傅给我验收软工文档,提到软工文档很重要,确实自己写的也不怎么样,毕竟第一次写都是照着模板和别人思维成品,一点一点磨出来的。有时候不会写了甚至从别人的博客上复制下来一段,写文档这个过程真的很难...

【软工】——软工文档总结

软件工程是系统化开发软件的过程,包括制定计划、需求定义和分析、软件设计、程序编写、软件测试、运行和维护六个步骤,每个步骤的文字性记录就是文档。文档在这里并不只是指导作用,还有说明、记录和总结的作用,它...

软工学习——文档总结(二)

概要设计和详细设计:概要设计是一个设计师根据用户交互过程和用户需求来形成交互框架和视觉框架的过程,其结果往往以反映交互控件布置、界面元素分组以及界面整体板式的页面框架图的形式来呈现。这是一个在用户研究...

软工文档总结

标准的软件开发过程 ,软件开发的标准过程包括六个阶段(瀑布型),而六个阶段需要编写的各类文件达14种之多,在每个阶段需要编写哪些文件?每个阶段都需要画哪种图? 1.可行性与计划研究阶段   可行性...

软工文档总结

经过了一段时间的学习,软工文档写完了,刚开始写文档的时候不知道要怎么去写,但是经过看源文档,慢慢的知道怎么去写文档了。其实写一套完整的文档就是相当于做一个系统的玩

软工文档总结【1】——从门外走进门

软工文档终于在写完了,师傅还没有进行验收,但是我还是想先总结一下我对于文档编写过程中的收货以及一些想法。从软工视频到软工文档,我几乎用时一个月才将它们完成,但是这个项目是我有史以来觉得走的很稳的一个项...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)