软件开发文档是软件开发使用和维护中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。详细介绍参见http://baike.so.com/doc/5027591.html
本次写文档时在机房收费系统做完之后写的,初次接触有很多欠缺,经过大约三周的时间已经结束,下面是画了一张图说明项目开发与文档的关系
下面概要的介绍对个别主要文档的认识:
可行性分析报告:主要提供给客户,项目开发经理,项目开发小组,说明该软件开发项目的实现在技术上、经济上和社会因素的可行性,评述为了合理地达到开发目标科工选择的各种可能实施方案,说明并论证所选定实施方案的理由。
数据库设计说明书:主要提供给项目开发小组,是对设计中的数据库的所有标识,逻辑结构和物理结构给出具体的设计规定。
软件需求说明书:主要提供给客户,系统分析小组以及开发小组,对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。
概要设计说明书:主要提供给客户,项目开发小组,系统分析小组,该说明书是概要实际阶段的工作成果,它说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等‘为详细设计提供基础。
详细设计说明书:主要提供给客户,项目开发小组,系统分析小组,着重描述每一模块式怎么实现的,包括实现算法、逻辑流程等。
测试计划:主要提供给开发人员,和审核小组为做好集成测试和验收测试,需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。
开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外‘还需对开发工作做出评价。总结出经验和教训。
初次接触文档书写,所以在写文档的时候参考了网上的资料例如: