软件工程文档

文档是软件开发使用和维护当中必备的资料,文档主要是管理人员、开发人员、操作人员、用户人员之间进行协商沟通的桥梁。

1.可行性分析文档

  • 主要是说明软件在经济上,技术上和市场情景等方面的可行性。
  • 根据这个文档,公司判断软件能否实现,客户要考虑是否把项目给公司,公司考虑是否要接这个项目。

2.需求文档

  • 用户与开发人员进行交流,开发人员根据和用户不断地进行交流,把用户的需求写成文档。需求文档是用户和需求人员沟通的桥梁,需求人员根据用户的要求来变更需求文档。
  • 需求文档对所开发软件的功能、性能、用户界面以及运行环境等作出详细的说明。也就是说,需求文档主要是写明软件有什么功能,性能,谁用这软件等内容。

3.数据库设计文档

  • 数据库设计文档,有些公司是由DBA(数据库管理员)设计的,有些公司是由架构师设计的,有些是由程序员设计的。该文档给出数据逻辑描述和数据采集的各项要求,为生成和维护系统的数据文件做好准备。

4.概要设计文档

  • 由公司的架构师,项目经理来完成。
  • 概要设计文档说明系统的功能分配、模块划分、程序的总体结构、输入输出及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计奠定基础。
  •  架构师根据需求文档设计系统的整体架构,项目经理列出开发计划,架构师完成概要设计之后,就开始给程序员分配任务,进行下一阶段。

5.详细设计分档

  • 程序员拿着架构师设计出来的概要设计文档,开始编写详细设计文档,所以一个项目里面会有很多份详细设计文档,因为每一个程序员负责一部分的功能,每个人写出来的详细设计文档都不一样。
  • 详细设计文档,详细的列出开发的方式,如何编写代码等内容,着重描述功能模块是如何实现的,包括算法和逻辑流程等

6.单元测试文档

  • 一般由程序员完成,这个文档因公司而异,有些公司写,有些公司不写。单元测试文档主要是从代码级别来测试系统(写单元测试,测试自己写的代码),也叫白盒测试。

7.测试计划:

  • 测试计划由公司的测试部门的测试人员进行测试,主要是在文档中列出测试的方案,测试的结果等。
  • 测试计划主要是站在客户的角度对系统的功能进行测试,也叫黑盒测试。

8.测试分析报告

  • 测试完成后,有些公司会写一个测试分析报告,把一些共性的问题挑出来,为以后的开发做个经验的积累。

9.项目开发总结报告

  • 一般是系统部署后,由项目经理对系统进行一个大的总结,看系统实际完成的情况与系统计划实施的情况有什么差异?包括进度,资金、人力的投入情况等,总结出经验和教训。

10.用户手册

  • 详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。用户手册就相当于我们平时看的说明书一样,说明你的系统如何使用。

11.操作手册

  • 针对的对象主要是操作员,为操作员了解软件的运行情况和操作方法知识。

12.开发进度月报

  • 由公司的项目经理根据当前开发系统的进度填写。

 

posted on 2013-01-19 20:05 雨落天涯 阅读( ...) 评论( ...) 编辑 收藏

转载于:https://www.cnblogs.com/mingxuanyun/archive/2013/01/19/3084233.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值