《软件文档写作-超市信息管理系统(共22页).doc》由会员分享，可在线阅读，更多相关《软件文档写作-超市信息管理系统(共22页).doc（22页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、精选优质文档-倾情为你奉上辽 宁 工 业 大 学 软件文档写作 实训报告题目： 超市信息管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术 班 学 号： 学生姓名： 指导教师： 王彦华 教师职称： 助教 起止时间： 2010.11.22-2010.12.6 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号 学生姓名 专业班级软件技术 实训题目 超市信息管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、
2、具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日专心-专注-专业目 录第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档
3、所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类软件文档的作用： 软件文档在软件开发中占有突出的地位和相当的
4、工作量。高效率、高质量的开发、分发、管理和维护对转让、变更、修正、扩充和使用文档。对充分发挥软件产品的效益有着重要意义。软件文档的作用如下：1) 项目管理的依据。文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2) 技术交流的语言。项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3) 项目质量保证。文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。4)支持培训与维护.合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5)支持软件维护。软件文档提
5、供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6) 记载软件历史。软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。软件文档分类：从形式上来看，大致可分为两类： 1)是开发过程中填写的各种图表，可称之为工作表格。2)是应编制的技术资料或技术管理资料，可称之为文档或文件。 按照文档产生和使用的范围，软件文档大致可分为三类： 1)开发文档：这类文档是在软
6、件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一砦工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。 3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、数据要求说明书、软件需求说明书。2.2软件文档所采用的标准根据软件工程标准制定
7、的机构和标准适用的范围，可分为5个层次：国际标准、国家标准、行业标准、企业(机构)标准、项目(课题)标准。ISO 9000标准概述：ISO 9000是国际标准化组织建立以来制订和公布的几千个标准中，影响最深远和普及最迅速的一个，其对各国经济生活所起的以下特点作用不可低估。我们在观察这一现象时，注意到ISO 9000的以下几个特点：(1) 国际性。ISO 9000已成为各国对质量保证和质量管理制度的共同理解。(2) 完整性。ISO 9000系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计20个标准，形成了一个完整的体系结构。(3) 兼容性。作为ISO 9000系列标准
8、核心的三个质量保证标准是逐一包容的。即9001标准的内容最全面，9002标准排除了设计工作的质量要求，仅限于生产制造过程，9003标准仅限于检验和试验工作的质量要求。可以说，依次适用范围渐窄。(4) 主动性。选用和实施ISO 9000标准、建立质量体系的主体，是企业的主动行为。(5) 可信性。ISO 9000的认证是授权认证机构对供方质量体系进行的独立、公正的活动，因此，具有相当的说服力和可信度。(6) 指导性。ISO 9000标准文本只是给出了质量管理和质量保证的原则，具体如何实施，需要供方结合自身机构的实际情况，特别是供方企业文化，进行创造性的解决。(7) 科学性。ISO 9000标准的背
9、后是现代质量管理的科学原理。(8) 实践性。具体表现在，标准文本不是空洞的条文，并基于大量的质量管理实践。如标准可向前追溯，得知其源于英国国家标准和美国军用标准等。2.2 软件文档的主要内容我所做的软件文档是学生信息管理系统软件文档。学生信息管理系统软件文档包括3个模块，其具体内容如下： 1) 基本信息管理：学生信息，成绩类型，课程信息。2)教师管理：教师教室。3)系统用户管理：用户信息，修改密码，切换用户。 第3章 实 例3.1 软件需求说明实例软件需求说明书1引言1.1编写目的日益发展的现代科技使得计算机技术渗透到各个领域，加上飞速发展的社会经济，更使得二者有利的结合，进入信息化时代。特别
10、是对数据库相关的知识应用更是与日俱增。通过市场调查，本系统着眼于市场上的各中小型超市，力求完善现有的中小型超市的资源、信息管理，为相关企业提供便捷，优质，完善的服务，从而提高自身竞争力。1.2背景a为完成本次软件设计的任务，我们小组成员一致选定超市管理系统为本次软件设计的题目和方向。b在开发过程中，我们针对当前各超市对经营业务和人事管理的特点和技术人员的实际水平，尽量采用易懂易读的人机界面，是用户可以在短时间内完全掌握。在目前状况下，超市管理仍存在一些问题，比如：不能有效地管理每种商品，收款结算速度慢，容易出现营业差错，不宜进行商品调价，盘点效率低等，而且在超市日常管理中，商品的进、销、存等决
11、策以经验为主，缺乏实时分析功能，管理人员对及时传递资料的要求始终得不到满足。超市形态的高速发展，其经营管理也变得愈加复杂，日常所需要处理的数据量也逐渐增大，商业运转的中间环节也越来越多，原始的人工管理已无法应对这复杂的市场。为此，在选题过程中，我选择了超市管理系统设计题目，依靠现代化的计算机信息处理技术来管理超市，从而节省了大量的人力、物力，改善了员工的工作条件，减轻了劳动强度，并且能够快速反映出商品的进、销、存等状况和各种反馈信息分析，使管理人员快速对市场的变化做出相应的决策，加快超市经营管理效率。C对使用该系统的用户只需要有基础的计算机知识，通过少量的培训就能熟练的使用该系统来实现对超市的
12、管理。比如进货、销售、库存商品，用户对清单的核对审查登记。1.3定义项目的名称：超市销售管理系统。本项目的任务提出者及开发者是超市销售管理系统软件开发小组，用户是超市经营者。本产品能具体化，合理化的管理超市中的商品信息、进出信息，用结构化的思维方式去了解超市的基本运作原理和超市后台程序设计。1.4参考资料【1】 张海藩 ，软件工程导论，清华大学出版社。【2】 张基温 ，信息系统开发案例，清华大学出版社。【3】 党建武 ，管理信息系统，兰州大学出版社。2任务概述2.1目标针对大多数用户对计算机知识的有限性，该系统尽量做到用户易学的操作环境，使用户方便的使用该系统来达到管理超市的目的，如结账体系，
13、库存体系，财务管理体系，商品管理体系，员工信息体系等。该系统主要实现的功能有一些几点：系统权限的设定、原始数据的输入、数据的汇总、数据的查询、数据的删除、数据的修改。2.2用户的特点该系统会涉及到超市的管理者，采购人员，销售人员，仓库管理人员，财务登记员等。不同的用户有不同的信息和实际操作，需要分开分析来提高系统的完善性。2.3假定和约束a系统软件的经费限制为3000元。b该系统按计划一步步实施，需要在要求的时间内完成任务。在这个时间段里，要充分的完成完善该系统。3需求规定 3.1对功能的规定输入信息处理操作输出信息用户登录用户名、密码核对主操作界面商品管理代码，名称，数量，金额查询，删除，修
14、改，添加相关具体信息界面进货管理代码，名称，数量，金额查询，删除，修改，添加相关具体信息界面库存管理代码，名称，数量，金额查询，删除，修改，添加相关具体信息界面销售管理代码，名称，数量，金额查询，删除，修改，添加相关具体信息界面3.2对性能的规定3.2.1精度查询时应保证查询所有的相关信息。即保证查全率。查询时应保证你所查信息的准确率。3.2.2时间特性要求在机器配置达到系统要求的情况下，该系统可在大多数平台上流畅运行。相应时间控制在1秒内，更新处理时间控制在2秒内，数据的转换和传送时间控制在2秒内3.2.3灵活性该系统适合在所有主流windows平台下流畅运行。本系统操作灵活，不同的用户可以
15、进如不同的界面来直接查询和自己相关的管理信息。本软件使用任何普通的pc机，对操作中出现的变化也可随用户的操作来完成。3.3输人输出要求系统默认的输入设备为键盘，鼠标等读取设备，输出设备为显示器和打印机。具体输入内容及相关信息：输入数值位数类型用户名10Char密码10Char代码10Char名称20Char数量15Long金额15Float3.4数据管理能力要求商品基本信息：商品号：大小为10字节；名称：不超过20字节，数量：不超过15字节，金额：不超过15字节。对于销售记录等所需记录的内容相似，采用相同的方式。对商品基本信息、库存管理、销售记录内容的存储的各表，至少需要100M以上的空间，即
16、至少需要500M的空间进行数据的存储，并至少需要1G以上的空间对增长的数据进行保存。3.5故障处理要求1）磁盘碎片过多、数据库存储空间不够，引起数据库反应变慢等问题需要对磁盘进行扩展和维护；2）执行程序非正常退出，修改源代码前，应先备份；3）SQL Sever 2000未启动，引起访问问题，应先启用数据库服务器；4）具体问题需具体分析，多多配合资料查询解决问题。3.6其他专门要求本系统采用了用户权限的设定，增加了系统的安全性，用户在输入正确密码后才能进入，也可选择是否保存密码。由于系统分为几个大的模块，各个模块分别对不同的信息分开管理，使用户使用方便，易懂。4运行环境规定4.1设备标准设备：P
17、C机，扫描仪等。客户端：操作系统（win2000及以上）。CPU(主频500M及以上)。最小内存（128MB内存）。最小磁盘空间(20GB)。上网能力（宽带上网）。服务器：操作系统（win2000server）。CPU(主频2G以上)。最小内存（512内存）。上网能力（光线接入、高速宽带连接）。4.2支持软件系统使用access数据库作为运行库。既保证系统的安全性，又大大降低系统对科技环境的要求，方便灵活配置。Xin2000以上的操作系统。编译程序。数据库管理系统。4.3接口该系统与数据库相连（输入商品基本信息和销售记录等信息），同时数据库也用来保存各用户的信息4.4控制本软件在Power B
18、uilder系统的支持下完成，展示界面由主窗口和子窗口嵌套而成，窗口操作通过按钮来控制，不同的按钮进行不同的操作，实现不同的功能。3.2项目开发计划实例项目开发计划（GB856788）1引言1.1编写目的本开发计划的目的是：（1）把在开发过程中对各项工作的人员、分工、经费、系统资源文件等问题的安排用文档形式记载下来，以便根据计划开展和检查本项目工作，保证项目开发成功。（2）制定项目组开发过程中的评审和审查计划，明确相应的质量管理负者人员。（3）规定软件配置管理的活动内容和要求，明确配置管理工作的人员。1.2 背景本项项目软件名称：超市信息管理软件文档。零售可能是世界上最古老的行业之一，在IT技
19、术诞生前的几千年，零售业就已经出现了。特别是近几年，零售业竞争风起云涌。在IT技术渗入零售业之后，零售业已经发生了很多的变化，现在信息技术已经俨然成为零售业行业的核心竞争力。每天都有众多商家开始刚刚涉足、转行零售业，对于信息化认识处于表面层次，业务流程和信息系统建设需要一段时间的探索、认识和渐进过程。零售业的商家们开始考虑这样的事情：怎样通过运用信息技术来优化和调配内部资源，科学管理日常业务，提高工作效率和经营业绩，使自身零售业务做好、做强和做大。开发的系统要求界面友好，方便直观。既要为用户设计好解决问题或达到目标所需要的条件或功能，同时系统或系统部件要满足合同、标准，规范或其它正式规定文档所
20、需具有的条件或权能。任务来源：软件技术081班超市信息管理软件文档课程设计。开发人员：辽宁工业大学软件学院“超市信息管理软件文档”开发小组：1.3定义项目的名称：超市销售管理系统。本项目的任务提出者及开发者是超市销售管理系统软件开发小组，用户是超市经营者。本产品能具体化，合理化的管理超市中的商品信息、进出信息，用结构化的思维方式去了解超市的基本运作原理和超市后台程序设计。1.4参考资料【1】 张海藩 ，软件工程导论，清华大学出版社。【2】 张基温 ，信息系统开发案例，清华大学出版社。【3】 党建武 ，管理信息系统，兰州大学出版社。2项目概述2.1工作内容本项目开发过程中需要进行的主要工作为：开
21、发符合用户需求的软件，并编制相关文档和计划。2.2主要参加人员组成见表B-1表B-1人员组成见角色参加人员项目管理李继超分析员李继超高级程序员南芳苑程序员南芳苑测试人员冷旭配置管理人员，文档编制辅助人员，培训师田丽楠硬件安装，测试人员冷旭2.3产品2.3.1程序程序名称：超市信息管理系统使用语言：VB6.0存储形式：磁盘，磁带，磁鼓2.3.2文件程序名称：超市信息管理系统使用语言：VB6.0存储形式：磁盘，磁带，磁鼓必须提交给用户的文档：项目开发计划：把对于在开发过程中各项工作的负责人员、开发进度、 所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开发工
22、作。资金分配方案：对各项开发项目的过程进行预资金分配，以此来预计开发本软件所需的资金并在很大程度上保证了项目开发过程中不至于资金无法周转。系统使用手册：详细记录本软件的使用方法和注意事项，使得用户能在最大程度上利用该资源，同时也在很大程度上延长了该软件的使用质量。系统维护手册：将该软件在运行过程中可能会出现的故障及其一定程度上的解决方法记载下来，以便用户可以对一些常见的故障按照该手册自行解决问题。详细技术资料：将开发该软件所用的技术详细的记载下来，方便在此方面有一定了解的用户对其进行检验。2.3.3服务服务：开发单位向用户提供服务；人员培训（从项目交接时至用户掌握该系统的使用方法）；系统安装（
23、项目交接时，保证系统正常运行）；系统保修（从项目交接时起的三年内）；系统维护（从项目交接时起的五年内）。验收标准：系统运行流畅，出错率为：1次/5天。2.3.4非移交的产品1在关于用户权限：（希望建立一个多维的用户权限管理，单位等级、薪金权限、操作权限等）单位权限：上级单位可以察看下级单位所有人员信息；基层单位只能察看自己所有人员信息。薪金权限：只有经过授权的人员才能察看，其他人员的薪金状况，（与单位等级有一定关系）。操作权限：本单位只能对本单位的员工情况进行操作（输入、修改），同时可以对由其直接任命的人员进行相应操作。如总部对总部所有员工进行相关操作，同时对根据规定由总部任免的人员进行相关操
24、作，如分公司总经理、经营部经理、分公司财务经理等。分公司或经营部只有对总经理等人进行查询权限。对输入的数据的格式进行判断，如果不合法则进行提示。2.4验收标准1在项目开发过程中所编写的各种文档，例如项目问题处理跟踪表，项目跟踪，项目变更通知单，里程碑，评审检查等。2涉及到原创的专利技术的某些程序2.5完成项目的最迟期限完成最后期限为： 2011-01-122.6本计划的批准者和批准日期批准单位：辽宁工业大学教务处 批准日期：2010年11月24日3实施计划3.1工作任务的分解与人员分工任务分解和人员分工见表B2表B-2任务分解和人员分工表任务姓名参加时间项目开发计划李继超全部软件需求李继超全部
25、概要分析田丽楠全部用户手册田丽楠全部操作手册南芳苑全部数据库设计南芳苑全部详细设计冷旭全部需求分析冷旭全部用户单位领导小组：负责人：李继超成员：李继超.南芳苑.田丽楠.冷旭职责：提供、协调、确认需求，验收测试。3.2接口人员（1）负责说明负责接口工作的人员及他们的职责，包括：（2）负责本项目同用户的接口人员；（3）负责本项目同本单位各管理机构，如合同计划管理部门、财务部门、质量管理部门等的接口人员；（4）负责本项目同个份合同负责单位的接口人员等。3.3进度项目启动时间：2010-12-1。项目交付时间：2011-01-20进度：包括可行性分析、需求分析、软件概要设计、软件详细设计、编码、测试、
26、安装、转换、确认、培训等阶段活动和任务的进度安排。“超市信息管理软件文档”PERT图如图B-3所示，图B-3超市信息管理软件文档3.4预算由于该100万人民币。3.5关键问题连接数据库SQL2000，以及类型的相互转换。4支持条件4.1计算机系统支持（1）硬件环境服务器：处理器（CPU）Pentium900（推荐Pentium4 1.2GB）。内存容量（RAM）：至少256MB（推荐512MB）。客户端：处理器（CPU）：Pentium133MB或更高。内存容量（RAM）：64MB或更高。（2）软件环境数据库服务器端：操作系统：Microsoft Windows XP或更高版本。数据库管理系统
27、：ORACLE，配置TCP/IP协议。Web服务器端：操作系统：Microsoft Windows XP或更高版本。Visual Studio.NET 2005，配置TCP/IP协议。4.2需由用户承担的工作考虑到本项目的最终用户为学生，学校应向本系统开放其内部数据库资源，以便实现所有功能。4.3由外单位提供的条件此项暂缺。5专题计划要点对于超市信息管理的具体实现，我们考虑进行网络服务，必要时可以从任意一台连入互连网进行对超市信息的管理、查询等功能。 第4章 实训日记第1-3天：分组，选择题目。我们小组4个人选择的题目是超市信息管理系统。第4-6天：网上查阅了大量关于超市信息管理系统软件工程文
28、档的相关资料并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且要对每个细节要进行全面的设计和说明。第5-13天：我做的是软件需求和项目开发计划。首相了解对超市信息管理软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查资料找答案和大家共同研究探索解决，再完成实例一之后用同样的方法进行着实例二的编写，再完成实例二之后，通过2周的实训，完成实训总结内容，总结这2周的收获。第14天：完成超市信息管理软件工程文档报告，上交作品。第5章 实
29、训总结这是一门实践性很强、交叉性很强的学科，它提供给我们的不仅是一种方法论，更是一种世界观。在没有接触软件工程这门课时，我一直认为软件就是程序。能编出解决问题的程序就OK了，从没有想过，在写一个程序之前还要构思几份文档（可行性分析、需求分析、概要设计）。如果别人给你50万让你们团队开发一个软件，如果他要求你们团队给这个软件永久维护，那么你要去跟他协商付100万。很多软件公司倒闭就是因为维护上的问题。至此我才明白维护软件是软件生存周期中时间最长的一个阶段，它是最花费精力与钱财的一个阶段。其实在我接触软件后，渴望的是当一名软件工程师。现在才知道学软件工程专业后，去当一名软件工程师是最低层的也是最没
30、“技术”含量的。要做就做系统构架师，当然这需要我们的不懈努力才能达到。系统构架师的职责是设计一个公司的基础构架，并提供关于怎样建立和维护系统的指导方针。恍然发现学软件不仅是学软件，相关的管理能力也是需要具备的。当然理论知识是用来指导实践的，亲身体验才能领悟软件工程的妙用。课设我们选择了超市管理系统，主要是这个系统我们接触比较多，对于它的流程还是比较清楚的。虽然如此我们还是花了很大的时间去完成它。记得当时我们定下这个题目是晚上，在讨论用什么语言实现时，大家各自说出自己比较善于的语言。然后均衡了下，定下用VB做开发语言。同时我们定下不管以后遇到什么困难都要坚持下去的准则。在课设期间我们没少跑图书馆
31、，上网，查阅各种资料，对比各本书上实现超市管理系统的代码。最终把所有课设的所有事情弄好了。当然这只是个概述。我印象尤深记忆深厚的是最初实现文档那块。刚开始，软件工程这门课还没学多少，基本的设计理念就很模糊。文档到底该怎么写，很纠结。于是我从网上狂下相关文档。通过粘贴与复制终于一份内容乱七八糟的需求分析文档出来了，当然这只是用来借鉴的。我们照着那个样子在结合团队项目的相关实例开始了文档的写作。我们的文档总是一个人先写好，再拿给另一个人改，最后由第三个人评审。大家都觉的可以了，才过关。测试报告虽然是我一个人完成了，但也经历了不少时间，当然这时间是按小时算的。首先把大体写出了，然后修改，再增加信息。
32、软件工程课程虽已结束，但我对于软件工程的学习才刚刚开始。我体会到项目管理的重要性，随着软件规模、复杂度的不断增加，项目开发中更多的是协作、管理和控制。我学习到很多一般性的方法，例如：需求获取、模块化、分治、估算、计划等等。同时，我也认识到使用计算机解决实际问题的复杂性，在图灵机模型和冯诺依曼体系的计算机框架下，人们认识表达的过程（不断反复、逐步深化）和计算机的实现过程（顺序执行）相差甚远，软件工程方法要提供给程序员们一种更加有效的对客观世界问题域进行形式化的过程方法。参考文献1 萨师煊、王珊.数据库系统概论.北京:高校教育出版社1985；2 王勇领.计算机数据处理系统分析与设计.北京:清华大学出版社1986；3 张基温.信息系统开发案例.北京;清华大学出版社1999；4 党建武.管理信息系统，兰州大学出版社2001；5 毕庶伟.管理信息系统分析与设计.北京:机械工业出版社1992；6 郑人杰.实用软件工程（第4版）.清华大学出版社.2003.47 罗先文.黄煜.徐军.软件工程基础.重庆大学出版社.2005.38 王新颖.软件工程与文档编写.北京大学出版社.2007.69 张海藩.软件工程导论.清华大学出版社.2005.1010 肖刚.实用软件文档写作.清华大学出版社.2009.511 徐世河.管理信息系统设计教程.电子工业出版社.2003.8