【软件工程】-文档总结

前言

  软件工程的文档一共有12个,开始写第一篇的时候无从下手,编到了词穷,后来通过站在巨人的身上,写起来轻松多了,当然这一次的学习中,还有不理解的地方,在接下来的学习中会查漏补缺,每一个文档的作用都不一样,写的阶段也不一样,使用的人也大有不同,所以文档是非常重要的。
  

软件文档的重要性

  文档也称文件,文档常常用来表示对活动,需求,过程或结构进行描述、定义、规定或认证的信息,规定了软件设计和实现的细节,说明软件的操作命令。文档是软件产品的一部分,没有文档的软件就不称其为软件,编写文档的主要目的在于规范化软件的生产,给软件的设计,编码,测试,维护等提供依据。

根据文档产生和使用范围分类:

这里写图片描述

每个文档的作用

  • 可行性研究报告
    可行性研究报告是项目组长编写,预期读者给老板和开发人员看,看到后综合各种社会因素,如经过有关的自然、社会、经济、技术等进行调研、分析比较以及预测建成后的社会经济效益。从而为投资决策提供科学依据。如果觉得可行,确定最优方案,那么就能够开发。

  • 项目开发计划书
    开发人员编写,预期读者是项目经理,开发人员小组,老板。为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

  • 软件需求说明书
    管理人员和用户协商编写,内容是用户对系统的需求,预期读者是开发人员,用户,测试人员。便于用户,开发人员进行理解和交流,明确了开发方向,是整个开发工作的基础,作为测试和验收的依据。

  • 概要设计说明书

    开发人员编写,预期读者是开发人员,维护和测试人员。说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据库设计和出错处理设计等,是概要设计的主要成果。为详细设计做好准备。

  • 详细设计说明书
    开发人员编写,预期读者是开发人员,维护和测试人员,准确的描述数据库的设计,描述每一块模块怎么实现的,包括算法和具体流程,为系统的实现和测试做准备。

  • 用户操作手册
    开发人员编写,预期读者是用户,目的为了帮助用户了解系统功能,如何使用,遇见一些小问题能够自己去解决。

  • 测试计划
    开发人员编写,预期读者是测试人员,目的是为了找出项目中的问题,要对软件的计划、设计、编码进行查错和纠错,经历一系列的流程,满足需求规格说明说,软件才能算好软件。

  • 测试分析报告

  • 测试人员编写,预期读者是测试人员,开发人员,维护人员,目的是对测试完成的结果和数据等加以记录和分析总结。

  • 开发进度月报
    开发人员编写,预期读者是管理部门人员,目的让管理人员对项目进度能有了解,总结一个月内遇见的问题以及问题如何解决的和下个月的计划,汇报工作。

  • 项目开发总结报告
    开发人员编写,预期读者是管理部门人员,目的是让软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。

  • 数据库设计说明书
    开发人员编写,预期读者是开发人员,管理人员,目的说明数据库表信息,表详细,表之间的关系,把信息描述清楚写成的文档。

  • 数据要求说明书
    开发人员编写,预期读者是设计人员,开发人员。数据要求说明书是整个数据设计的关键,能够真实充分的反映现实数据,易于理解、改正、易于查看各种数据的流向及关系。

猜你喜欢

转载自blog.csdn.net/a15076159739/article/details/80136518
今日推荐