软件开发(面向对象方向)文档大纲编写要求.doc

本文档仅是本人对软件开发设计文档大纲编写的一些建议，仅供参考。因实际系统实现的规模及功能所限，有些内容应该存在不同程序的增删。在设计文档中所绘制的图形之前，一定要对所使用的图例进行说明后再进行绘制。前言 设计内容的应用领域，所设计内容在现实世界中的意义。毕业设计中具体的研究内容，是大学学习的哪个领域知识的实际应用。毕业设计中实现了哪些算法的设计与实现，运用了计算机软件开发的什么系统架构来实现。1 问题定义（本章主要是按照毕业设计任务书的要求，完成所开发系统的问题定义，主要由以下几节组成）1.1 系统名称（根据项目的来源、项目完成的目标、项目将发挥的作用等，完成系统名称的定义）1.2 现行系统存在的问题这一部分视所设计的内容而定。如果是用户提出的实现项目，可按下面的内容来书写：（分析目前对用户现行系统的了解，分析现行系统在管理、规范化、现代化办公等方面存在的使用计算机进行管理能够避免的主要问题）如果是为了提升本人的开发能力而选择的一个研究领域的内容进行验证，这部分可不写。1.3 项目目标（分析现行系统中可以采用计算机进行管理的各子项，根据系统提出相应的要求，并对实现的目标系统进行描述）一定要重视这一部分的内容，这是考核所开发的系统设计和实现的参考依据。1.4 项目范围（对项目在开发过程中所涉及到用户方面的组织、人员、环境、计算机软硬件资源、开发中经费的初步估算。）1.5 可行性研究阶段经费估算2 可行性研究2.1 系统目标（分析所开发的系统在所研究的领域的地位、发挥的作用、以及目标能够达到的目标。）2.2 可行性分析2.2.1 可行性分析的目的2.2.2 技术可行性技术上的可行性主要是根据系统分析所得到的对待开发的软件、支撑软件、硬件环境和操作人员的要求，以及有关的约束和限制，来分析利用现有的技术是否能实现待开发的软件。它包括可得到的硬件和支撑软件在功能和性能上是否满足系统的要求，是否有满足系统性能要求的算法，开发人员的技术水平能否胜任系统的开发等。2.2.3 经济可行性经济可行性首先要进行待开发软件的成本估算和成本/效益分析，以确定待开发软件是否有开发的价值。这里的效益包括新开发的系统所带来的收入增加，以及新开发的系统比原有系统在使用费用上的减少。对于开发成本低、经济效益高的软件应积极开发，而对于开成本高、经济效益低的软件或开发成本与经济效益差不多的软件通常不应开发。2.2.4 操作可行性 从软件调研、设计、开发、实施等四个方法分析各环节中将遇到哪些困难，是否具有克服这些困难的方法，如果存在无法解决的障碍，则这个项目无具有可操作性。2.2.5 法律可行性法律可行必是指待开发的软件是否存在知识产权等与法律有关的问题，如有这类问题，该软件即使开发成功，也难以成为产品销售。（从系统软件、应用软件、技术资料、合同责任等方面分析）2.2.6 可行性研究结论（对系统是否可进一步开发给出明确的观点。）3 XX系统需求分析 首先对系统需求分析的目的、采用的方法及手段及在本章最终完成的内容进行描述。重点对用例图、用例描述进行说明。3.1 XX系统需求3.1.1 XX系统功能需求针对系统目的对目标系统进行概要性的功能描述。3.1.2 XX系统环境需求软件的环境需求，需要描述出出软件系统运行时所处环境的要求。硬件环境：主机类型、外围设备、数据通信接口等；软件环境：系统软件平台(包括单机操作系统、网络操作系统及应用软件、数据库管理系统等等)，以及使用用户达到的基本要求的条件3.1.3 XX系统可靠性需求软件可靠性需求，按照实际运行环境对所开发的软件提出要求，尽量在需求分析阶段将所有的问题进行暴露。对于运行实效后可能产生的后果要有充分估计，应对软件运行的可靠性提出较高的要求。3.1.4 XX安全保密需求软件安全保密性能在软件的需求分析过程当中应当对所开发的软件的安全性进行特殊设计分析,使其在实际开发完成之后的运行过程中安全性能得到必要的保证。3.1.5 XX系统用户界面需求用户界面的需求，对于用户界面的细致性以及易用性进行需求分析使其达到客户要求3.1.6 XX系统资源使用需求通过资源需求使用分析，使得所开发的软件在运行时所需的系统资源处于用户可接受范围。3.2 XX系统需求分析3.2.1 XX系统分析用例模型并根据用户需求功能性描述绘制系统用例图。 （在绘制用例图前对用例图中所用到的图形元素进行说明）3.2.2 YY1用例描述这一小节是对系统中的各用例进行详细的说明，以达到对系统与客户沟通与交流的目的或者对目标系统实现的预期目标的考核。用例设计时需综合考虑用户所提出的需求，在用例描述中进行阐述系统用例描述的内容用例编号：用例名称：用例描述：(属性)行为者：先决条件：后置条件：活动步骤：异常处理方法：用例之间的关系：备注：3.2.2 YY2系统用例描述：3 3 系统用例活动图设计依据系统用例的描述，用典型系统用例中的活动进行绘制。注意用例标识的一致性。这儿设计的活动图仅是一个需求阶段的过程表述，在设计阶段还会有更详细的设计。 4 系统分析4.1 XX系统类划分 这一章节的内容，是在系统用例分析的基础上，实现类的设计。根据用例描述及用例活动图描述，设计相应的实体类、边界类及控制类的设计。一定注意与用例描述的一致性问题。4.1.1 实体类分析4.1.2 边界类分析4.1.3 控制类分析4.2 XX系统类的描述本小节主要描述系统中当不同的类之间存在多个简短的方法时，描述控制流的整体序列。显示并发进程和激活。显示在协作图中难以描述的时间序列。显示涉及类交互而与对象无关的一般形式。动态模型描述了系统随时间变化的行为，这些行为是用从静态视图中抽取的系统的瞬间值的变化来描述的，在UML的表现上，动态模型主要是建立系统的交互图和行为图。交互图包括时序图和协作图，行为图则包括状态图和活动图时序图(SequenceDiagram)用来显示对象之间的关系，并强调对象之间消息的时间顺序，同时显示了对象之间的交互。4.3 XX系统类设计 系统用例的实现是由类按照一定的时序完成的。时序图的绘制一定要与实体类、边界类、控制类设计保持一致。5 系统设计5.1 用例设计5.1.1 实体类设计5.1.2 边界类设计5.1.3 控制类设计5. 2 代码设计5.3 数据库设计（一定要参考实例的数据库设计过程，但不要对没有关联的实体之间硬凑联系，尽量规范到3NF）4.5.1 代码设计4.5.2 数据库设计4.4.2.1 概念模型设计4.4.2.2 关系模式设计4.4.2.3 物理数据库设计4.4.2.3.1 表名约束4.4.2.3.2 数据字典5.5系统安全性设计5.5.1 数据安全性数据保存、传输过程的安全性5.5.2 登录用户的安全性对用户的身份验证5.5.3 操作安全性对授权用户权限的授予和回收。5.5.4 系统安全性的其它考虑5.6 系统出错处理设计 如设置后备、性能降级、恢复启动等。5.6.1 出错输出信息5.6.2 出错处理对策5.7 系统维护设计说明为方便维护工作的设施，如代码维护模块等。5.8 限制条件（存储设计、接口条件、限制条件等，根据实际情况进行设计）6 编码6.1 编程工具的选择6.2 变量设计6.2.1 变量名设计原则6.2.2 变量设计6.2.2.1 全局变量设计6.2.2.2 局部变量设计6.2.2.2.1 YY1用例局部变量设计 ： ：6.2.3 程序清单6.2.3.1 YY1用例ZZ1清单6.2.3.2 YY1用例ZZ2清单6.2.3.3 YY1用例ZZ3清单 ： ：7 测试设计7.1 系统测试的基本原则（描述在实际设计中所采用的基本原则）7.2 XX系统单元测试7.2.1 YY1测试方案设计7.2.1.1 YY1用例输入测试方案7.2.1.2 YY1用例输出结果预测7.2.1.3 YY1用例测试结果预测7.2.1.3.1 测试记录7.2.1.3.2 结果分析 ： ：7.3 XX系统测试结论7.3.1 软件能力7.3.2 软件缺陷7.3.3 软件限制7.4 系统维护建议8 系统使用说明8.1 系统运行环境8.2 系统安装指南8.3 系统操作指南8.4 系统出现问题说明8.5 系统常见故障的处理说明以下内容仅供参考，具体请根据今年毕业设计装订的要求。毕业设计论文文档组成及排列顺序（请参照学校的要求做。以下仅给出以前的顺序，是否符合本届要求，需要核对）封面（学校下发）题名页（学校不发