1、辽 宁 工 业 大 学软件文档写作 实训报告题目： 超市信息管理系统软件文档 院（系）: 软件学院 专业班级： 学 号： 学生姓名： 指导教师： 教师职称： 起止时间： 2010.11.26-2010.12.2 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号 学生姓名 专业班级实训题目 超市信息管理系统软件文档实训任务实训任务及要求：1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出 2 个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指
2、导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日辽 宁 工 业 大 学 课 程 设 计 说 明 书（论 文）目 录第 1 章 实训目的与要求 .11.1 实训目的 11.2 实训的实验环境 11.3 实训的预备知识 11.4 实训要求 1第 2 章 软件文档及其组成 22.1 软件文档的作用及分类 .22.2 软件文档所采用的标准 .22.2 软件文档的主要内容 3第 3 章 实 例 .43
3、.1 概要设计实例 43.2 用户手册实例 .11第 4 章 实训日记 .17第 5 章 实训总结 .18辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）1第 1 章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出 2 个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环
4、境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）2第 2 章 软件文档及其组成2.1 软件文档的作用及分类1.软件文档的作用在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。 1)提高软件开发过程的能见度。2)提高开发
5、效率。3)作为开发人员在一定阶段的工作成果和结束标志。 4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 2软件文档的分类软件文档从形式上来看，大致可分为两类： 一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。 按照文档产生和使用的范围，软件文档大致可分为三类： 开发文档、 管理文档、 用
6、户文档。 2.2 软件文档所采用的标准为了在工作更好地利用标准，现列出 2006 年国家发布的软件工程相关的国家标准并进行简要介绍，需要时可以去获取和查阅。GB/T 8567-2006 计算机软件文档编制规范本标准根据 GB/T 8566-2001信息技术软件生存周期过程的规定，主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。本标准原则上适用于所有类型的软件产品的开发过程和管理过程。本标准参考国际标准 ISO/IEC 15910：1999 信息技术软件用户文档过程等标准制定的。GB/T 20158-2006 信息技术 软件生成周期过程 配置管理该标准是基于 G
7、B/T 8566 的配置管理（CM）过程，规定了计算机软件配置管理的实施要求，以用于软件产品的开发、维护和运行。该标准适用于：任何形式的软件；软件产品的整个生存周期和生存周期内的单个开发、维护和运行项目，从分包商或销售商获辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）3得的软件；软件产品的供方和需方。适用于供、需双方的情况，并且双方属于同一组织时同样适用。该标准等同采用国际标准 ISO/IEC 15846：1998。2.2 软件文档的主要内容1.可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明
8、并论证所选定实施方案的理由2.软件需求文档：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。3.概要设计文档：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 4.详细设计文档：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。5.项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。6.测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人
9、员、测试用例的选取原则、测试结果允许的偏差范围等。 7.测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 8.用户手册：软件的质量是由多个方面构成的，用户手册也是平衡软件质量的一个重要标准。9.操作手册是指导具体操作的工具书，它涉及软件设计完成后用户所关心的有关操作的内容。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）4第 3 章 实 例3.1 概要设计实例概要设计说明书1 引言1.1 编写目的随着计算机网络技术以及数据库技术的迅速发展，管理信息系统得到了广泛应用。对于一个超市来讲：货品数量少则数以百计，多则数以万计；另外，
10、不同超市的实际情况也有所不同。要对这些货品进行统一、高效的管理，靠人工完成工作量庞大、难免有错漏之处。为此，一个自动化的超市货品管理系统的开发非常必要。期望读者包括：用户、分析员、客户组织的负责人及评审组审查人员。1.2 背景项目的名称： 超市信息管理系统项目产品名称： 超市信息管理系统项目的开发者：田丽楠用户： 超市管理人员1.3 定义为了便于阅读理解本文，在此解释一些在本文中用到的简写和专业术语：超市信息管理系统以下简称 MIS.1.4 参考资料1李香敏SQL Server 2000 编程员指南第 1 版.北京.希望电子出版社2Watts S.Humphrey软件工程规范第 1 版.清华大
11、学出版社.2004 年2 总体设计辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）52.1 需求规定对本超市信息管理系统的主要的输入输出项目、处理的功能性能要求如下：表 2.1 超市信息管理中的功能功能名称 输入项 输出项 执行权限 功能描述商品信息管理模块商品档案信息 录入信息成功或录入信息错误及错误原因管理员 完成对商品基本资料的收集及存储进货管理模块需要修改、增加供应商及其商品的信息重新显示修改后的信息，错误则显示错误提示。管理员 提供修改与更新供应商的信息及其商品的信息。销售管理模块条形码编号或名称等索引信息显示商品的信息、单价、总价格，在销售成功是更新商品数量等信息管理员
12、 销售时显示商品的基本信息，并在售后更新商品的库存信息库存管理模块商品信息 显示添加，修改后的商品信息管理员 管理仓库商品，并在提醒管理员进货2.2 运行环境（1）硬件环境：建议配制 PIV 以上的处理器，256M 以上内存。（2）软件环境：Windows XP ，SQL Server 2005，Microsoft Visual 2005（3）使用人员：会 Windows 操作的超市管理人员2.3 基本设计概念和处理流程本系统的处理流程图如下：辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）6是否失败用户登录 重试 退出登录成功登录 商品信息管理销售的商品信息管理供应商及相关商品管
13、理仓库商品信息管理开始图 2.1 处理流程图2.4 结构本系统的模块图如下：超市信息管理系统商品信息管理 进货管理 销售管理 仓库管理商品信息查询商品信息修改新商品信息添加供应商品更新供应商添加供应文件处理所有商品查询商品信息添加商品数量修改毁坏商品信息处理仓库信息修改仓库商品信息添加图 2.2 超市信息管理系统模块图辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）72.5 功能器求与程序的关系各项功能需求的实现同各块程序的分配关系：表 2.2 功能需求与程序关系表功能名称 增加 修改 删除 查询 打印 退出商品信息管理模块 进货管理模块 销售管理模块 库存管理模块 2.6 人工处
14、理过程A: 管理员处理：商品信息的输入、删除、更新、添加等，查询时的查询条件的输入和相关信息的打印等。B：普通查询用户：查询条件的设定，查询结构的打印等。2.7 尚未问决的问题A：数据库逻辑结构的整体规范。B: 各个模块之间的主装。3 接口设计3.1 用户接口包括商品基本信息管理、进货管理、销售管理和仓库管理界面，其中商品信息管理对商品信息的增，改，删除等设置；进货管理分供应商档案管理和供应商商品管理，增、改、删除供应商及其商品信息；销售管理提供销售时对商品的信息显示及修改；仓库管理管理仓库库存商品。删除、增加、修改、查询等操作无单独界面。3.2 外部接口（1）应用系统通过 ODBC 和数据库
15、沟通。（2）软件与硬件的接口如下：表 3.1 软件与硬件接口表辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）8键盘 鼠标 打印机主模块 管理模块 查询模块 3.3 内部接口如下是超市信息管理系统的内部接口，具体内容如下表:表 3.2 内部接口商品信息管理模块进货管理模块销售管理模块库存管理模块打印管理模块系统说明模块商品信息管理模块 进货管理模块 销售管理模块 库存管理模块 4 运行设计4.1 运行模块组合商品信息管理模块用来管理商品的一些基本信息，是本系统中数据管理的基本对象。管理超市的全部商品信息。商品信息的收集与修改功能：商品信息管理模块，仓库管理模块商品数量更新功能：销售
16、管理模块，仓库管理模块查询，打印功能：商品信息管理模块，销售管理模块，仓库管理模块4.2 运行控制A、商品信息查询模块当用户输入正确的商品信息名称时，点击查询，系统便转入与 SQL Server 商品信息数据库，按照表中记录依次查询与用户输入的商品名称相匹配的记录，并将表中该条记录的所有信息分为报表信息反馈给用户。硬 件接 口软 件接 口模 块名 称模 块名 称辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）9B、销售管理模块更新当销售信息管理员对商品销售信息进行更新时，输入要更新的内容，点击更新按钮就可以实现对商品销售信息的更新，也可以通过管理页面的查询界面对更新的信息进行查询4
17、.3 运行时间在本超市信息管理系统中，商品信息更新模块是占用系统各种资源时间最大的模块，约百分之五十，而商品信息查询模块占用的系统各种资源时间不多，约百分之二十五。5 系统数据结构设计5.1 逻辑结构设计要点主要逻辑结构如下：商品信息管理： 属性：CNo（条形码编号） 整数（唯一标示符）Cname（商品名称） 变长字符串Cmd(生产日期) 日期Cbd（变质日期） 日期Cpm(生产厂家) 变长字符串Cp(商品进价) 实数Cp2(商品零售价) 实数5.2 物理结构设计要点系统的物理结构具体由数据库来设计与生成，管理人员查看的信息都以表格的形式显示，基本表的设计如下：表 5.1 商品信息表字段名 字
18、段类型 长度 主键/外键 字段值约束商品编号 char 6 P NOT NULL供货商号 char 6 F NOT NULL名称 varchar 80 0 NOT NULL计量单位 varchar 4 0 NOT NULL类别 varchar 8 0 NULL单价 money 4 0 NOT NULL辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）10备注 text 50 0 NULL说明：此表存放商品信息。关于保密的条件：为每个操作人员设置账号及口令，规定每一级操作人员的权限。5.3 数据结构与程序的关系本超市信息管理的数据结构与程序的关系如下表：表 5.1 数据结构与程序的关系
19、表Select * fromCreate table Insert intoUpdate* set 商品基本信息表 销售信息表 仓库信息表 6 系统出错处理设计6.1 出错信息1.商品的编码输入不规范或相同编码的商品出现其他不同信息，系统报错，提示管理员检查输入。2.商品数量超出范围(小于零或大于仓库或货架的存放量)系统报错。3.如果链接数据库失败，填出提示对话框，提醒管理员没有连上数据库，以便管理员及时检查故障。6.2 补救措施1.当操作人员输入的信息不符导致出错时，提示操作人员输入有误，重新输入信息。2.对数据库采取日记记录技术和海量转储技术，使数据库遇到硬件损坏或崩溃时能及时调用出原来的
20、数据，尽量恢复到不久前的一次正常数据存储阶段。3.后备技术，即准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去，或周期性地把系统数据上传到FTP 服务器。6.3 系统维护设计程序数 据结 构辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）11（1）可以查看已经录入商品信息的个数。（2）查看数据库的容量，包括剩余空容量和已经使用量。（3）对数据库采取回滚措施，即一次操作失败，回滚到最近一次正常操作状态。3.2 用户手册实例用户手册（GB856788）1 引言1.1 编写目的随着计算机网络技术以及数据库技术的迅速发展，管理信
21、息系统得到了广泛应用。对于一个超市来讲：货品数量少则数以百计，多则数以万计；另外，不同超市的实际情况也有所不同。要对这些货品进行统一、高效的管理，靠人工完成工作量庞大、难免有错漏之处。为此，一个自动化的超市货品管理系统的开发非常必要。期望读者包括：用户、分析员、客户组织的负责人及评审组审查人员。1.2 背景项目的名称： 超市信息管理系统项目产品名称： 超市信息管理系统项目的开发者：田丽楠用户： 超市管理人员1.3 定义为了便于阅读理解本文，在此解释一些在本文中用到的简写和专业术语：超市信息管理系统以下简称 MIS.1.4 参考资料1李香敏SQL Server 2000 编程员指南第 1 版.北
22、京.希望电子出版社2Watts S.Humphrey软件工程规范第 1 版.清华大学出版社.2004 年辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）122 用途2.1 功能该软件主要功能是实现超市信息的管理系统，具体包括登陆、管理、商品进货管理、商品查询管理、销售管理和库存查询管理。各模块的基本功能和极限范围如下：登陆模块：由于本系统是管理者的使用，所以不可能开放注册。管理模块：本系统的主界面，管理者在此界面实行各种管理，决策操作。销售管理模块：单击添加按钮，系统会自动得出商品的编号和应付的金额。然后管理员再添加销售商品的其他信息。库存查询管理模块：超市进货，销售的过程中，仓库
23、会堆积大量的货物。对这些货物进行统一的管理调度显得格外重要，库存查询功能可以很直观的看到各种货物的编号，存量等信息。2.2 性能2.2.1 精度在运行此软件时候，对输入数据额精度不作严格要求，若输入数据是文本类型的数据，则其精度要求为最精度的数据；若输出数据时整型或长整形类型，则其精度要求为保留小数点后一位，而在传输过程中的数据精度不作要求。2.2.2 时间特性响应时间：页面首次访问响应时间为0.1 元。（5）商品的销售量、库存量、进货量都应为正，否则输出错误报告。4.2.1 输入数据的现实背景输入数据现实背景主要是：a. 输入数据的来源主要是超市管理办公室，通过键盘输入到计算机。b. 输入的
24、频度是根据每一项操作状态的函数，一般来说是几天输入一次。c. 没有时间限制。d. 有效的输入范围就是输入各个项，当输入有误时无法跟数据库对应，则不显示任何信息或弹出错误提示，需重新输入。e. 数据本身无保密措施。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）15f. 对输入的数据可做备份转储，无用的数据可以删除。4.2.2 输入格式登录时用户名输入框输入为英文字母和数字的组合。密码输入框输入为 6-16 为英文字母和数字的组合字符串。分数输入栏输入为数字加小数点，其中小数点后只容许两位小数。姓名输入栏输入格式为下两者之一：（1）全中文（2-10 各中文字长度） ；（2）全英文（长
25、度不大于 40 个字符） 。4.2.3 输入举例 输入：商品编号（018 位）商品名称（115 位） 单位量（个，包，克）规格型号（g,kg,ml）单价（小数点后只容许两位小数）例如：西红柿的商品编号：2405200924.3.1 输出数据的现实背景输出数据的现实背景：a使用超市信息管理人员；b使用频度随时；c媒体电脑；4.3.2 输出格式采用文本格式输出提示信息或操作结果信息。4.3.3 输出举例若密码输入不正确则输出：“输入密码不正确！请重新输入！”若查询商品时，数据库中没有记录则输出：“对不起，该商品还没有记录！”4.4 文卷查询查询时可输入与该项相关的信息，系统对加有空格可以自动处理，
26、如果用户输入的辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）16信息有误，系统将给与提示。对于实体信息的主标志提供模糊及精确查询。4.5 出错处理和恢复本软件可能产生的错误为数据库的错误信息，应由数据库管理员对数据库进行维护。为了确保系统恢复的能力，数据库管理员要定期对数据库进行备份。4.6 终端操作ARGOX 的 PT 系列手持终端，因其经济实惠、性价比表现高的特性，在超市信息管理系统中就采用 PT80 来实现实时信息传输。首先，由于卖场占地空间相当大，且移动终端的操作并不限定在特定区域，因此为确保移动终端在任何地点均能与后端主机保持实时的通讯，在安装 AP 接受点时必须注意覆
27、盖到整个商场甚至各个角落，包括：进货区、商场区、仓库、财务室等。 辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）17第 4 章 实训日记1、11 月 22 日 分组和选定实训题目，并布置任务。首先经过老师的讲解，我们总整体上了解本次课程设计的设计任务，以及分组方法。经过商量，我和 4 个同学组成一组，选择做超市信息管理系统，确定了设计项目，而且分配每人的任务。 2、11 月 25 日 通过网络或图书获得相关资料，我去图书馆查阅有关软件工程的材料，了解软件工程的内容及软件开发的方法，并且上网查寻了有关商品销售系统管理的资料，并详细记录下来，为软件文档的编写做了充足的准备。3、11
28、月 27 日 编写软件概要设计说明书，根据从图书馆和网上查询的资料，编写超市信息管理系统的概要设计说明书。由于是第一次写，在编写过程中遇到了很多困难，但通过老师同学的帮助和自己的努力都解决了，用了两天的时间完成了任务。4、11 月 29 日 编写项目开发计划，根据从图书馆和网上查询的资料，编写超市信息管理系统的用户手册。由于之前写过概要设计说明书，经过了三天查阅资料和不断的修改，最后很好的编写出了用户手册，完成了任务。5、12 月 3 日 完成报告并进行后续工作，今天是实训的最后一天，对已经完成的超市信息管理系统文档在进行检查，将错误的地方改过来，将缺少的地方添加进去，最后完成了本次软件文档写
29、作实训。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）18第 5 章 实训总结通过这两个星期课程设计的学习，让我进一步了解简单的超市信息管理系统软件文档的设计过程。这次软件文档的设计我是遵循软件文档的开发步骤来进行的设计，做好基础工作，认真分析用户的需求，设计一个性能优异、结构合理的软件文档。做的过程中我遇到了很多的问题，但是最后通过努力和老师不厌其烦的解答以及查找资料最后都得到了解决。在设计概要设计时，我首先了解编写的目的以及背景，让后对超市信息管理系统的主要的输入输出项目、处理的功能性能进行解释，对其运行环境进行声明。在画处理流程图时我遇到了很多的问题，但经过查询资料画出超市
30、信息管理系统的处理流程图。接下来设计本系统的模块图，由于对系统的流程有了一定的了解所以画此图时相比较容易了许多。接下来编写用户手册，首先说明用户手册的功能，让后对本系统的精度、时间特性、灵活性、安全保密性进行设计。详细说出了本系统的安装与初始化，数据输入输出的实现和格式以及本超市信息管理系统的出错和恢复。在设计中我深知自己掌握的知识还远远不够，把掌握的一些理论知识应用到实践中去，总会出现这样或那样的问题，不是理论没有掌握好，而是光知道书本上的知识是远远不够的，一定要把理论知识和实践结合起来。把学到的知识应用到实际中去，多做多练，才可以把理论的精华发挥出来。知识不是知道了解就好，一定要去应用它，
31、发展它，让它在现实生活中得到充分的应用，从而解决一些问题，这才是学习的根本目的。而且知识又不是单一的，它是互相联系的。在设计阶段，通过对课题的深入分析与研究，迫使我对知识有了一定的了解。在遇到问题时，得到了老师与同学的细心帮助，使我感受到集体的力量是无穷的。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）19参考文献1. 黄鑫. 软件文档实例解析. 中国电力出版社2. 刘旭. 软件文档企划与调研指南. 中国电力出版社3. 宋劲松. 软件文档实例与研究. 国防工业出版社4. 胡建伟. 知识解答与软件文档. 西安电子科技大学出版社5. 连一峰. 软件文档技术.科学出版社6. 卢昱. 办公管理三加一. 国防工业出版社7.谭毓安. 办公物品管理实训解析 .北京希望电子出版社8. 王建国. 软件文档知识解答. 北京邮电大学出版社9.李香敏.SQL Server 2000 编程员指南第 1 版.北京.希望电子出版社10.Watts S.Humphrey软件工程规范第 1 版.清华大学出版社.2004 年
