软件工程软件文档写作

软件工程软件文档写作
辽宁工业大学生产实习实训总结报告
院（系）: 软件学院
专业班级：软件工程113班
学号： 111301066
学生姓名：谭福军
指导教师：姜瑶
教师职称：助教
起止时间： 2012.12.09-2012.12.21
课程设计任务及评语
本次实习以生产实习为主，生产实习是我们计算机专业的一项重要的实践性教学环节，旨在开拓我们的视野，增强专业意识，巩固和理解专业课程。

实习方式主要是请企业技术人员和企业管理人员、实习教师以讲座形式介绍有关内容。

（一）软件开发技术：
软件开发的内容是：需求分析书、设计说明书、代码规范说明书、测试计划。

软件开发的一般过程，包括设计软件的功能和实现的算法和方法、软件的总体结构设计和模块设计、编程和调试、程序联调和测试以及编写、提交程序。

第一步需求调研分析:相关系统分析员和用户初步了解需求，然后用WORD列出要开发的系统的大功能模块，每个大功能模块有哪些小功能模块，对于有些需求比较明确相关的界面时，在这一步里面可以初步定义好少量的界面。

系统分析员深入了解和分析需求，根据自己的经验和需求用WORD或相关的工具再做出一份文档系统的功能需求文档。

这次的文档会清楚例用系统大致的大功能模块，大功能模块有哪些小功能模块，并且还例出相关的界面和界面功能。

系统分析员和用户再次确认需求。

第二步概要设计:开发者需要对软件系统进行概要设计，即系统设计。

概要设计需要对软件系统的设计进行考虑，包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为软件的详细设计提供基础。

第三步详细设计:在概要设计的基础上，开发者需要进行软件系统的详细设计。

在详细设计中，描述实现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关系，需要说明软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑，以便进行编码和测试。

应当保证软件的需求完全分配给整个软件。

详细设计应当足够详细，能够根据详细设计报告进行编码。

第四步编码:在软件编码阶段，开发者根据《软件系统详细设计报告》中对数据结构、算法分析和模块实现等方面的设计要求，开始具体的编写程序工作，分别实现各模块的功能，从而实现对目标系统的功能、性能、接口、界面等方面的要求。

第五步测试:测试编写好的系统。

交给用户使用，用户使用后一个一个的确认每个功能。

第六步软件交付准备:在软件测试证明软件达到要求后，软件开发者应向用户提交开发的目标安装程序、数据库的数据字典、《用户安装手册》、《用户使用指南》、需求报告、设计报告、测试报告等双方合同约定的产物.《用户安装手册》应详细介绍安装软件对运行环境的要求、安装软件的定义和内容、在客户端、服务器端及中间件的具体安装步骤、安装后的系统配置。

《用户使用指南》应包括软件各项功能的使用流程、操作步骤、相应业务介绍、特殊提示和注意事项等方面的内容，在需要时还应举例说明。

第七步验收:用户验收。

（二）关于3G技术的知识：
3G是英文3rdGeneration的缩写，第三代移动通信技术，是指支持高速数据传输的蜂窝移动通讯技术。

3G服务能够同时传送声音及数据信息，速率一般在几百kbps以上。

国际电信联盟（ITU）在2000年5月确定W-CDMA、CDMA2000、TD-SCDMA以及WiMAX 四大主流无线接口标准，写入3G技术指导性文件《2000年国际移动通讯计划》（简称IMT—2000）。

CDMA是Code Division Multiple Access (码分多址)的缩写，是第三代移动通信系统的技术基础。

第一代移动通信系统采用频分多址(FDMA)的模拟调制方式，这种系统的主要缺点是频谱利用率低，信令干扰话音业务。

第二代移动通信系统主要采用时分多址(TDMA)的数字调制方式，提高了系统容量，并采用独立信道传送信令，使系统性能大为改善，但TDMA的系统容量仍然有限，越区切换性能仍不完善。

CDMA系统以其频率规划简单、系统容量大、频率复用系数高、抗多径能力强、通信质量好、软容量、软切换等特点显示出巨大的发展潜力。

目前3G存在四种标准：CDMA2000，WCDMA，TD-SCDMA，WiMAX。

下面分别介绍一下3G的几种标准：
1）W-CDMA也称为WCDMA，全称为Wideband CDMA，也称为CDMA Direct Spread，意为宽频分码多重存取，这是基于GSM网发展出来的3G技术规范，是欧洲提出的宽带CDMA 技术，它与日本提出的宽带CDMA技术基本相同，目前正在进一步融合。

其支持者主要是以GSM系统为主的欧洲厂商，日本公司也或多或少参与其中，包括欧美的爱立信、阿尔卡特、诺基亚、朗讯、北电，以及日本的NTT、富士通、夏普等厂商。

该标准提出了GSM(2G)-GPRS-EDGE-WCDMA(3G)的演进策略。

这套系统能够架设在现有的GSM网络上，对于系统提供商而言可以较轻易地过渡，而GSM系统相当普及的亚洲对这套新技术的接受度预料会相当高。

因此W-CDMA具有先天的市场优势。

2）CDMA2000：CDMA2000是由窄带CDMA(CDMA IS95)技术发展而来的宽带CDMA技术，也称为CDMA Multi-Carrier，它是由美国高通北美公司为主导提出，摩托罗拉、Lucent 和后来加入的韩国三星都有参与，韩国现在成为该标准的主导者。

这套系统是从窄频CDMAOne数字标准衍生出来的，可以从原有的CDMAOne结构直接升级到3G，建设成本低廉。

但目前使用CDMA的地区只有日、韩和北美，所以CDMA2000的支持者不如W-CDMA多。

不过CDMA2000的研发技术却是目前各标准中进度最快的，许多3G手机已经率先面世。

该标准提出了从CDMA IS95(2G)-CDMA20001x-CDMA20003x(3G)的演进策略。

CDMA20001x 被称为2.5代移动通信技术。

CDMA20003x与CDMA20001x的主要区别在于应用了多路载波技术，通过采用三载波使带宽提高。

目前中国电信正在采用这一方案向3G过渡，并已建成了CDMA IS95网络。

3）TD-SCDMA:全称为Time Division - Synchronous CDMA(时分同步CDMA)，该标准是由中国大陆独自制定的3G标准，1999年6月29日，中国原邮电部电信科学技术研究院（大唐电信）向ITU提出，但技术发明始于西门子公司，TD-SCDMA具有辐射低的特点，被誉为绿色3G。

该标准将智能无线、同步CDMA和软件无线电等当今国际领先技术融于其
中，在频谱利用率、对业务支持具有灵活性、频率灵活性及成本等方面的独特优势。

另外，由于中国内地庞大的市场，该标准受到各大主要电信设备厂商的重视，全球一半以上的设备厂商都宣布可以支持TD—SCDMA标准。

该标准提出不经过2.5代的中间环节，直接向3G过渡，非常适用于GSM系统向3G升级。

军用通信网也是TD-SCDMA的核心任务。

4）WiMAX：WiMAX 的全名是微波存取全球互通(Worldwide Interoperability for Microwave Access)，又称为802.16无线城域网，是又一种为企业和家庭用户提供“最后一英里”的宽带无线连接方案。

将此技术与需要授权或免授权的微波设备相结合之后，由于成本较低，将扩大宽带无线市场，改善企业与服务供应商的认知度。

2007年10月19日，在国际电信联盟在日内瓦举行的无线通信全体会议上，经过多数国家投票通过，WiMAX正式被批准成为继WCDMA、CDMA2000和TD-SCDMA之后的第四个全球3G标准。

开源对于行行业业的影响是无需置疑的，对于 WiMAX 也一样。

开源软件无线电 GNU Radio 是免费的软件开发工具套件。

它提供信号运行和处理模块，用它可以在易制作的低成本的射频（RF）硬件和通用微处理器上实现软件定义无线电。

这套套件广泛用于业余爱好者，学术机构和商业机构用来研究和构建无线通信系统。

GNU Radio 的应用主要是用 Python 编程语言来编写的。

但是其核心信号处理模块是C++在带浮点运算的微处理器上构建的。

因此，开发者能够简单快速的构建一个实时、高容量的无线通信系统。

尽管其主要功用不是仿真器，GNU Radio 在没有射频 RF 硬件部件的境况下支持对预先存储和（信号发生器）生成的数据进行信号处理的算法的研究。

二、MVC设计模式
MVC由Trygve Reenskaug提出，首先被应用在SmallTalk-80环境中，使许多交互和界面系统的构成基础，Microsoft的MFC基础类也遵循了MVC的思想。

MVC模式的目的就是实现Web系统的职能分工。

Model层实现系统中的业务逻辑，通常可以用JavaBean或EJB来实现。

View层用于与用户的交互，通常用JSP来实现。

Controller层是Model与View之间沟通的桥梁，它可以分派用户的请求并选择恰当的视图以用于显示，同时它也可以解释用户的输入并将它们映射为模型层可执行的操作。

超市管理从需求分析开始,项目采用Rational统一过程(RUP)为软件开发方法,以统一建模语言(UML)为分析设计描述语言,以J2EE为技术平台,完成了系统的架构设计和详细设计。

一是系统实现方面,由于系统的用户为前台营业员、少量的系统管理员、超市各部门管理人员、学校领导、考虑到系统多用户和跨平台的特征,所以系统采用了B/S和C/S 的混合架构,在实现B/S结构的多种解决方案中,针对用户需求和系统特点,采用J2EE技术体系,以及市场占有率高、成熟稳定的开源表现层框架STRUTS建立系统MVC架构,大大提高系统的性能,具体好的可维护性和可扩展性。

二是针对校办超市库存管理的独特特点,在对各种库存模型的反复比较下,我们库存预警和进货决策上选择了合理库存算法,实现了库存管理的智能化、自动化,商品结构的合理化,为学校超市节约了成本,超市进一
步扩展作好了技术支持。

三是在本系统使用了iRePort和jasperRePort技术实现了商品管理和人员管理的各种报表的自动生成,为领导层决策提供了有力的支持。

学校超市管理信息系统是该学院实现高校信息化的有机组成,属于学校服务管理信息系统中一个重要组成部分,是为了提高学校对学校超市商品管理、节约经营成本以及提高对人员管理的水平而设计开发的管理信息系统。

系统设计的目标是简化商品销售及商品管理的工作量,提高超市工作效率、降低成本,方便学院对超市人员的管理,满足用户及时沟通需要,实现与学校其它管理信息系统协同工作。

系统在投入使用后,取得了良好的效果和很好经济回报,该系统库存和进货的决策的智能化和自动化,给超市管理者的经营提供了有力的支持,大大降低了商品进货成本,随之销售价格的合理下降,使顾客得到了实惠,同时超市人员管理更加正规化,跟上了学院人事管理的步伐,提高了超市人员的工作积极性。

三、本人设计模块
我们组做的是班级管理系统，我负责详细设计和系统分析两个模块。

1．程序系统的结构：
2、模块设计说明
2.1程序描述
（1）目的：班级管理系统是为同学之间进行交流和联系提供的一个平台，虽然现在大多数人都能用各种聊天工具和同学朋友们联系，但是聊天工具具有一个最大的弱点就是安全性不高，一旦密码丢失或被盗，多有联系人资料都将丢失。

而我的班级管理系统能解决这个问题，所有同学的信息都将长期储存在数据库，用户登陆班级管理系统就能找到同学的信息，并与之取得联系，并且可以实时关注母校的动态。

现在我们也都面临毕业，拥有一个属于自己的班级管理系统也是很多同学的心愿，所以，设计并制作这个班级管理系统是有很大的实际意义的。

（2）特点：
1．具有分布性特点，可以随时随地进行查询、浏览等业务处理。

2．业务扩展简单方便，通过增加网页即可增加服务器功能。

3．维护简单方便，只需要改变网页，即可实现所有用户的同步更新。

4．开发简单，共享性强。

3.2功能
1.登入功能：系统首页提供登入对话框，输入用户名和密码，系统验证正确后进入系统，否则提示错误信息。

2．注册功能：该功能为浏览者提供注册功能，在注册界面填写相应信息，系统验证正确后，成为系统用户。

3．留言功能：它用于用户发表留言。

4．查看留言功能：用于查看系统中所有成员留言。

5．删除留言功能：用于删除系统中不需要的留言。

6.个人信息修改功能：用于修改用户注册信息。

7．查看班级信息功能：用于查看当前系统信息8．修改班级信息功能：用于修改班级信息。

9．上传相片功能：用于将照片发布在系统中的个人相册或集体相册中
10．删除相片功能：用于删除自己上传的照片。

11．浏览相片功能：用于浏览系统发布的照片。

12．发送短消息功能：用于在系统中发送短信，你可以指定发送对象。

13．查看短消息功能：用于查看是否有自己的短信，并且可以回复。

14．删除短消息功能：用于删除自己接收的不需要的短消息。

15．发布班级新闻功能：用语发布班级重要通知等。

16．修改班级新闻功能：用于修改新闻内容。

17．删除班级新闻功能：用于删除系统中的旧新闻。

18．添加教师功能：用于添加教师信息。

19．查看教师信息功能：用于查看教师信息，方便用户与教师取得联系。

20．查看用户信息功能：用于查看注册的所有用户信息
21．锁定用户：用于锁定违规操作的用户，用户被锁定后该用户不能在登录该系统。

22．用户权限设置功能：权限分为管理员、副管理员、普通成员。

2.2算法
VB连接sql数据库：
Option Explicit
Dim conn As ADODB.Connection
Dim rs As ADODB.Recordset
Private Sub Form_Load()
Set conn = New ADODB.Connection
Set rs = New ADODB.Recordset
conn.ConnectionString = "Provider=SQLOLEDB.1;Data Source=J:\Program Files\Microsoft SQL Server\MSSQL10.MSSQLSERVER\MSSQL\DATA\stc.mdf;Persist Security Info=true;User ID=sa;Initial Catalog=stc"
conn.Open
rs.Open "student", conn, , adCmdTable
'rs = Execute("select * from student")
Set my.DataSource = rs
rs.Close
conn.CloseEnd Sub
3.流程逻辑
4.测试用例
辽宁工业大学课程设计说明书（论文）
一、实习总结
程序开发的过程是一个很艰难的过程，一个程序的开发必然结合着许多的错误和困难，如果你对程序不是太了解，其间出现的困难更是非同凡响，即使是学了三年的我们要想非常熟练的应用程序将是非常困难的一件事情，这需要我们耐心的进行学习和了解决.在程序开发的过程当中不免会碰到不懂的问题，要善于总结和结合你所学过和用过的知道，查找相关书籍，对你不懂的章节和问题进行强化的理解和消化，经过错误的磨练才能够更好的锻炼自己，才起到了本次程序开发实验应该起到的效。

在程序开发过程中要学会积累在开发过程中出现的大量错误，错误的纠正后，将记住错误的关键所在，在下一次的编写过程中不要出现类似的这类错误。

程序开发过程中最困难的就是开始的阶段，大多数时候很多人开始的时候都不知道该怎么样去动手开发程序，要记住开发程序要一步步的来，只要我们懂得了开发过程中的模式，从浅入手、就没有完不成的设计，只要肯动手，肯动脑.一切皆是有可能的.遇到问题的时候不要是惊慌和失措，老师将是你最好的导师，同学将是最好的帮手，我们可以从他们那里得到很多的帮助。

学会一门语言将是未来竞争过程总必要要求，学习多门语言将是我们前进的方向，学精一门语言将是我们将来竞争与社会的有力砝码，所以努力学习和改正和积累经验将是我们现在所最应该解决的问题。

经验的积累将在今后的程序开发过程中起到十分重要的作用。

本次课程设计是经过老师的耐心讲述及指导才能顺利完成的。

虽然课程设计
只有几个星期的时间，但是平时老师的指导给本次课程设计奠定了良好的基础，
我能基本完成本次设计中的部分制作。

即使在设计过程中遇到了一些问题，翟老
师依然认真的辅导，帮助我解决了设计中的各种困难。

在课程设计时，翟老师给
予了我细心的讲解和辅导，使得课程设计能顺利、按时的完成，并让我在学习上
有了更进一步的提高。

7。