财务管理系统软件文档

辽宁工学院软件文档写作实训报告题目：财务管理系统软件文档院（系）:专业班级：学号：学生姓名：指导教师：教师职称：起止时间：2009.11.30-2009.12.11实训任务及评语目录第1章实训目的与要求 (1)1.1 实训目的 (1)1.2 实训的实验环境 (1)1.3 实训的预备知识 (1)1.4 实训要求 (1)第2章软件文档及其组成 (2)2.1软件文档的作用及分类 (2)2.2软件文档所采用的标准 (2)2.2 软件文档的主要内容 (2)第3章实例 (6)3.1数据库设计说明书实例 (6)3.2详细设计说明书实例 (14)第4章实训日记 (22)第5章实训总结 (23)参考文献 (24)第1章实训目的与要求1.1 实训目的本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。

1、了解软件开发周期各阶段的文档。

2、掌握各文档阐述的内容及作用。

3、了解文档所采用的国际、国家等相关标准。

4、了解各文档所涉及的软件知识。

5、掌握各文档采用的描述工具。

6、具体编写出2个主要的软件文件。

1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。

1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。

该实训应安排在毕业设计之前进行。

1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。

正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。

第2章软件文档及其组成2.1软件文档的作用及分类2.2软件文档所采用的标准可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。

它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

2.2 软件文档的主要内容一、开发文档1. 功能要求是来源于客户要求和市场调查，是软件开发中最早期的一个环节。

客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。

有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。

这份文档是需求分析的基础。

2. 投标方案是根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写投标方案，方案书一般包括以下几个重要的章节：前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。

需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。

技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。

项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。

技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。

系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。

项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

3. 需求分析包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。

以功能要求为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。

这里的功能描述跟以后的使用手册是一致的。

4. 技术分析包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。

以需求分析为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。

5. 系统分析包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。

以《需求分析》为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。

6. 数据库文档包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。

以系统分析为基础，进行详细的数据库设计。

必要时可以用图表解说，特别是关系数据库。

7. 功能函数文档包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。

以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。

8. 界面文档包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。

9. 编译手册包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。

客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

10. QA文档包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。

11. 项目总结包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

二、产品文档1. 产品简介包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。

2. 产品演示包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。

一般用Power point或者VCD 录制软件实现。

3. 疑问解答列出用户关心的问题和处理方法。

用于解答软件的操作功能和解决用户的疑难问题。

4. 功能介绍以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。

5. 技术白皮书以技术分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

6. 评测报告第三方权威评测报告。

包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。

7. 安装手册包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。

8. 使用手册包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。

9. 维护手册包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。

10. 用户报告包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。

11.销售培训包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等第3章实例3.1数据库设计说明书实例一.引言1.目的财务管理系统设计说明书主要介绍关于管理系统的数据库设计相关知识，适用于数据库编程人员和数据爱好者。

2.背景1)系统名称：财务管理系统2)数据库：Access二.结构设计1.设计原则数据库的安全性是指保护数据库以防止不合法的使用所造成的数据泄漏、更改或破坏。

在数据库系统中，大量的数据集中存放，而且为许多用户直接共享，是宝贵的信息资源，系统的安全保护措施就显得更为重要，它保护数据库防止恶意的破坏和非法的存取。

尤其是这种大型的数据库存放着十分重要的信息。

不允许出现任何差错。

在登录数据库时，系统让用户表示自己的身份，系统进行核实，鉴别此用户是否为合法用户，若是，系统进一步核实用户，通常要求用户输入口令，系统和对用户口令以鉴别用户身份。

这是一种简单可行的方法，实现起来比较方便。

用户还可以随时更改自己的口令密码。

1）数据录入和处理的准确性和实时性数据的输入是否准确是数据处理的前提，错误的输入会导致系统输出的不正确和不可用，从而使系统的工作失去意义。

数据的输入来源是手工输入。

手工输入要通过系统界面上的安排系统具有容错性，并且对操作人员要进行系统的培训。

在系统中，数据的输入往往是大量的，因此系统要有一定的处理能力，以保证迅速的处理数据。

2）数据的一致性与完整性由于系统的数据是共享的，在不同的设备类别中，设备是共享数据，所以如何保证这些数据的一致性，是系统必须解决的问题。

要解决这一问题，要有一定的人员维护数据的一致性，在数据录入处控制数据的去向，并且要求对数据库的数据完整性进行严格的约束。

对于输入的数据，要为其定义完整性规则，如果不能符合完整性约束，系统应该拒绝该数据。

3）据的共享与独立性整个设备发布系统的数据是共享的。

然而，从系统开发的角度上看，共享会给设计和调试带来困难。

因此，应该提供灵活的配置，使各个分系统能够独立运行，而通过人工干预的手段进行系统数据的交换。

这样，也能提供系统的强壮性。

2.数据性质：因为本系统投入运营后，系统的安全与可靠性直接关系到企业日常工作能否顺利进行。

这里提出的安全性、可靠性方案与措施，可以基本满足该企业的要求：1）系统总体技术方案为本地机结构。

加强系统的适应能力，这样即使在网络中断的情况下，也可以继续管理。

单机主要起到存储数据的作用。

2）数据库的安全性数据库的安全性是指保护数据库，以防止不合法的使用所造成的数据泄漏、更改或破坏。

由于数据库中存放关在量的重要数据，并且为各种用户所共享，数据的安全显得格外重要。

在一般的计算机穖中，安全措施是逐级设置的：用户标识和鉴定存取控制操作系统安全保护密码存储数据库的安全控制的一般方法有：用户标识和鉴定，存取控制，审计，数据加密，视图的保护。