搜索
1附件十一：《广西工学院计算机系工程型毕业设计文档组成及写作规范》广西工学院计算机系工程型毕业设计文档组成及写作规范软件工程型毕业设计文档要求参照国家软件工程文档编制的相关要求，为了避免在软件开发中文件编制的不足或过分，可将软件文件的编制要求同软件的规模大小联系起来，采用如下图的软件文档体系。小规模软件中规模软件大规模软件超大规模软件软件需求与开发计划软件开发计划可行性分析报告对应大规模软件所制定的文档可进一步细分项目开发计划软件需求说明软件需求说明数据要求说明测试计划测试计划软件设计说明软件设计说明概要设计说明详细设计说明数据库设计说明使用说明使用说明用户手册操作手册测试分析报告模块开发卷宗模块开发卷宗测试分析报告测试分析报告项目开发总结开发进度月报开发进度月报项目开发总结项目开发总结根据本规范，一个计算机软件的开发过程中，一般应产生如下14种文档。（1）可行性分析报告可行性分析报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能选择的各种方案；说明并论证所选定的方案。编制指南见附件《可行性分析报告》。2（2）项目开发计划编制项目开发计划的目的是用文档的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需硬件条件等问题作出的安排记录下来，以便根据本计划开展和检查本项目的开发工作。编制指南见附件《项目开发计划》。（3）软件需求说明软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。编制指南见附件《需求规格说明书》。（4）数据要求说明数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。（5）测试计划这里所说的测试计划，主要是指整个程序系统的组装测试和确认测试。本文档的编制是为了提供一个对该软件的测试计划，包括对每项测试活动的内容，进度安排、设计考虑、测试数据的整理方法及评价准则。编制指南见附件《测试计划》。（6）概要设计说明概要设计说明书又称为系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、程序系统地组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制指南见附件《概要设计说明书》。（7）详细设计说明详细设计说明书又可称为程序设计说明书。编制的目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文档可以不单独编写，有关内容合并入概要设计说明书。编制指南见附件《详细设计说明书》。（8）数据库设计说明数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构做出具体的设计规定。（9）用户手册用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的用途，3并且能够确定在什么情况下，如何使用它。（10）操作手册操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方面的细节。可与用户手册整合编制，编制指南见附件《用户操作手册》。（11）模块开发卷宗模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有利的技术信息。（12）测试分析报告测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文档加以记载。编制指南见附件《测试分析报告》。（13）开发进度月报（周报）开发进度月报（周报）的编制目的是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处理开发过程中出现的问题。编制指南见附件《开发进度月报》。（14）项目开发总结项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。编制指南见附件《项目开发总结》。45工程型毕业设计说明书目录第2章项目开发计划............................................................112.1引言.................................................................................................................................................112.2项目概述.........................................................................................................................................112.2.3.1程序..........................................................................................................................................122.2.3.2文档..........................................................................................................................................122.3．实施计划.....................................................................................................................................122.4人员组织及分工............................................................................................................................132.5交付期限........................................................................................................................................132.6专题计划要点................................................................................................................................13第5章概要设计说明书..........................................................205.1引言................................................................................................................................................205.2任务概述........................................................................................................................................215.3总体设计........................................................................................................................................215.4接口设计........................................................................................................................................215.5数据结构设计................................................................................................................................225.6运行设计........................................................................................................................................225.7出错处理设计................................................................................................................................225.8安全保密设计................................................................................................................................225.9维护设计........................................................................................................................................22第7章用户操作手册............................................................267.1引言................................................................................................................................................267.2软件概述........................................................................................................................................267.3运行环境........................................................................................................................................277.4使用说明.................................................................................................................................