软件文档写作实训报告李东博客网站.docx

1、软件文档写作实训报告李东博客网站辽 宁 工 业 大 学 软件文档写作 实训报告题目： 博客网站系统软件文档 院（系）: 软件学院 专业班级： 软件技术081班 学 号： 081404023 学生姓名： 安凯辰 指导教师： 王彦华 教师职称： 助 教 起止时间： 2010.11.22-2010.12.6 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号081404023学生姓名安凯辰专业班级软件技术081班实训题目 博客网站系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文

2、档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日目 录第1章 实训目的与要求 11.1 实训目的 11.2 实训的实验环境 11.3 实训的预备知识 11.4 实训要求 1第2章 软件文档及其组成 22.1软件文档的作用及分类 22.2软件文档所采用的标准 22

3、.3 软件文档的主要内容 3第3章 实 例 53.1 数据库设计实例 53.2操作手册 9第4章 实训日记 15第5章 实训总结 16参考文献 17第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计

4、算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类软件文档，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源 程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档

5、本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图2.1.1中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定 一些工作计划或工作报告，这些计划和报告都要提供给管理人员， 并得到必要的支持。管理人员则可通

6、过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。图2.1.1 文档桥梁作用2.2软件文档所采用的标准在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开

7、发经费的预算、所需的硬件及软件资源等。 软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 用户操作手册：本手册详细描述软件的功

8、能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 项目开发总结报告：软件项目开发完成以后，应与项目

9、实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 2.3 软件文档的主要内容可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开

10、发目标可供 选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。 软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议， 也是实施开发工作的基础。 数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。 概要设计说明书：该说 明书是概要设计阶段的工作成

11、果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理 设计等，为详细设计奠定基础。 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果

12、加以分析，并提出测试的结论意见。 开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。第3章 实 例3.1 数据库设计实例3.1.1个人博客系统采用E-R图的方法进行数据库概念结构设计,系统E-R图3.1.1所示图3.1.1系统E-R图3.1.2数据库设计一个设计良好的数据库，可以使系统的实现变得非常的简单。同时，也可

13、以使系统的执行速度变得很快。反之，一个设计混乱的数据库，不仅增加了吸引的管理实现过程，同时在系统的执行过程中，使得检索变得很慢，降低效率。所以数据库的设计是一个系统设计很重要的步骤。根据系统功能设计要求和模块划分，本站的数据库主要有用户信息、文章信息、管理员信息、照片信息、文章类型信息、评论信息、投票信息、朋友圈视图。数据库的设计通常是以一个已经存在的数据库管理系统为基础的，常用的数据库管理系统有Access、SQL Server、Oracle、My SQL等。根据用户需求和系统分析，本系统采用SQL Server2000数据库管理系统。在SQL Server2000数据库管理系统中建立名称为

14、博客的数据库。1.个人博客系统的关系模式如下：管理员信息（ID, 昵称，性别，生日，头像）日志（ID，日志标题,日志内容，日志类别，发表时间）图片(ID，图片名称，图片所属相册，图片地址，上传时间）相册（ID，相册名称，相册描述，创建时间）留言（ID，留言内容，留言时间）日志类别（ID，类别名称）2.数据库中包括的表有管理员表，日志表，图片表，相册表，留言表，文章分类表，背景音乐管理表，用户信息表。（1）表3.1.1为管理员表（Users）列名数据类型长度允许为空主键描述IDint4否是标志，自动递增1Unicknamevarchar50是否博主昵称Sexchar2是否博主性别Birthday

15、varchar10是否博主生日Uimagevarchar200是否博主头像Uadressvarchar20是否博主的地址表3.1.1管理员表（2）表3.1.2为日志表（Article）列名数据类型长度允许为空主键描述IDint4否是标志，自动递增1Titlevarchar50是否日志标题Categoryvarchar20是否日志类别Contenttext是否日志内容Ardatedatetime是否发表时间表3.1.2日志表(3)表3.1.3为图片表(tb_Image)列名数据类型长度允许为空主键描述IDint4否是标志，自动递增1Pnamevarchar50是否图片名称Albumnamevar

16、char20是否相册名称ImagePathvarchar200是否图片路径Pdatedatetime是否上传时间表3.1.3图片表(4)表3.1.4为相册表（Album）列名数据类型长度允许为空主键描述IDint4否是标志，自动递增1Anamevarchar20是否相册名称Adatedate是否相册创建时间Descriptiontext是否相册描述表3.1.4相册表(5)表3.1.5为留言表(Message)列名数据类型长度允许为空主键描述IDint4否是标志，自动递增1Messagetext是否留言内容Mdatedatetime是否留言时间Mwritervarchar50是否留言者表3.1.

17、5留言表(6)表3.1.6为文章分类表(ArticleCategory)列名数据类型长度允许为空主键描述IDint4否是标志，自动递增1Cnamevarchar20是否日志类别表3.1.6文章分类表(7)表3.1.7为用户信息表字段名类型长度主键外键是否为空Idint10是不是不允许U_nameVarchar50否不是不允许U_userPassVarchar50否不是不允许U_relNamevarcher50否不是不允许U_Emailvarchar50否不是允许U_sexvarchar10否不是允许U_questionvarchar500否不是允许U_answervarchar500否不是允许

18、U_statevarcharInt 否是不允许U_heardImagevarchar100否否不允许U_musicIdint10否外键不允许表3.1.7用户信息表(8)表3.1.8 为背景音乐管理表字段名类型长度主键外键是否为空Idint10是不是不允许M_nameVarchar50否不是不允许M_sinnerVarchar50否不是不允许M_urlvarcher50否不是不允许M_clickvarchar50否不是允许表3.1.8背景音乐管理表3.1.3数据流分析为了建立一个满足用户需求的博客系统，系统分析人员应在深入调查、详细占有资料的基础上，集中分析管理活动中信息运动的规律和存在的问题，

19、研究如何改善信息流的运动，满足用户管理决策活动中的信息需求。因此要对调查材料进行加工、提炼、抽出其中之反映花店信息运动规律的部分，把用户的需求“翻译”成对信息处理功能的需求，以建立系统的逻辑模型。数据流图 (DFD) 是组织中信息运动的抽象，是管理信息系统逻辑模型的主要形式。这个模型不涉及硬件、软件、数据结构与文件组织，它与系统的物理描述无关，只是用一种图形及与此相关的注释来表示系统的逻辑功能。图形描述简明，清晰，不涉及技术细节，所描述的内容是面向用户的。因此数据流图是系统分析人员与用户进行交流的有效手段，也是系统设计的主要依据之一。数据流图是在对业务流程图进行分析的基础上，从系统的科学性、管

20、理的合理性、实际运行的可行性角度出发，将信息处理功能和彼此之间的联系自顶向下、逐层分解，从逻辑上精确的描述新系统具有的数据加工功能、数据输入、数据输出、数据存储及数据来源和去向。3.1.4数据结构优化关系规范化在关系数据库中，对关系模式的基本要求是满足第一范式(1NF)。但是，有些关系模式存在插入、删除异常、修改复杂，数据冗余等毛病。所以，我们必须使关系规范化以方便数据库的操作。规范化的基本思想是逐步消除数据依赖中不合适的部分，是模式中的各关系模式达到某种程度的“分离”，即“一事一地”的模式设计原则。因此所谓规范化实质上是概念的单一化。关系模式的规范化过程是通过对关系模式的分解来实现的。通过对

21、本系统关系模式的分析，在关系模式中，每一个非主属性完全函数依赖于码，但是某些关系模式中仍存在着传递依赖,所以本系统的关系模式属于第二范式（2NF），那为什么不把关系模式优化到第三范式（3NF）呢？因为事实上并非范式越高越好，高范式的关系模式也许会影响到数据库的操作速度，所以考虑到这一点本系统仍将关系模式优化到2NF。3.2操作手册3.2.1个人博客系统运行环境个人博客系统采用SQL Server 2005后台数据库，当SQL Server 2005安装完毕之后，就可以创建数据库MyBlog，并在该数据库中创建本系统所需的数据表。创建好数据库后就可以为本系统创建ODBC数据源1服务器运行环境：处

22、理器：733内存：256硬盘：20G输入输出设备：打印机等。网络设备：Hub、网卡、网线等。2运行硬件环境：计算机数量:30台本系统采用C/S体系结构，由一台服务器与多个客户机组成，配置如下：服务器：硬件：80x86系列微机CPU:733以上内存：256M以上硬盘空间：40G以上软件：Windows Server、Access等工作站：硬件：80x86系列微机CPU: 166以上内存：16以上硬盘空间：2G以上软件：Windows 9x或Windows 2000 professional 、Access等 。输入输出设备：扫描仪、打印机等。网络设备：Hub、网卡、网线等。（2） 个人博客系统的

23、运行所需的软件环境： Windows XP Professional+.NET Framework+SQL Server 2005。3.2.2系统操作指南本系统是基于B/S模式的系统，所以可以直接通过IE运行。主页面是所有的浏览者都可以浏览的界面，而点击管理，输入密码，博主就可以进入管理界面，对日志、留言等进行管理。3.2.3系统功能简介个人博客系统是模仿QQ空间的博客系统，它主要的功能有：日志的管理，留言的管理，相册的管理，个人资料的管理。（1）日志管理：博主和游客都可以浏览和查询日志信息，其中查询数根据日志的类别进行查询。管理员不仅可以浏览和查询日志信息，还能更改、添加和删除日志信息，以更

24、新日志数据库，以便发布日志信息。博主和游客可以浏览的日志信息包括：日志的标题，日志的内容，日志的类别，日志的发表时间。管理员即博主可以查看和修改的日志信息包括：日志的标题，日志的内容，日志的类别，博主可以根据实际需要进行日志的删除和修改添加。（2）相册管理：博主和游客都可以浏览相册信息，博主不仅可以浏览，还可以添加、编辑和删除相册。博主和游客可以浏览的相册信息包括：相册的名称，相册的描述，相册的创建时间。博主可以查看和修改的相册信息包括：相册的名称，相册的描述，博主可以根据实际需要进行相册的删除和修改添加。（3）留言管理：博主和游客都可以浏览和添加留言信息，博主不仅可以浏览、添加，还可以删除留

25、言。博主和游客可以浏览的相册信息包括：留言的内容，留言的时间。博主可以根据实际需要进行相册的删除和修改添加。（4）个人资料管理: 博主和游客都可以浏览个人资料信息，博主不仅可以浏览，还可以编辑个人资料。博主和游客可以浏览的个人资料信息包括：博主的昵称，博主的性别，博主的生日，博主的地址和博主的头像。博主可以查看和修改的个人资料信息包括：博主的昵称，博主的性别，博主的生日，博主的地址，博主可以根据实际需要修改个人资料。3.2.4用户登陆如果你是已注册用户，可以在主页点击登录输入你的用户名和密码，点击登录按钮。登录成功后，直接进入主界面。在登录这个主界面后，你可以发表日志，查看评论，修改删除日志、

26、评论。如图3.2.1所示。图3.2.1用户登陆3.2.5用户注册如果你还不是本网站的用户，可以通过主页提供的“注册”链接，注册成为本系统的用户。在注册过程中，请注意根据系统提示信息输入用户的个人资料。填完后单击提示按钮进入登录窗口，即注册成功。如图3.2.2所示。图3.2.2用户注册3.2.6博客查询输入你所要查询的博客名称即可完成查询，通过这个页面，你可以查询到博客里的相关内容，查询完毕后将你所显示的内容显示的页面上如图3.2.3所示图3.2.3博客查询3.2.7发表日志单击如图3.2.4中的新建按钮进入如图3.2.5在文本框输入你要写的内容。如果想在日志中放入一张图片可点击左上角的照片按钮

27、进入如图3.2.6所示，上传即可。图3.2.4新建日志图3.2.5书写日志图3.2.6添加图片第4章 实训日记第1天：自由分组，选择题目。我们小组4个人选择的题目是博客系统。第2-5天：网上查阅了大量关于博客系统软件工程文档的相关资料并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且要对每个细节要进行全面的设计和说明。第6-13天：我做的是软件需求说明书和项目开发计划。首相了解对软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查

28、资料找答案和大家共同研究探索解决，再完成实例一之后用同样的方式按部就班的进行着实例二的编写，再完成实例二之后，通过2周的实训，完成实训总结内容，总结这2周的收获。第14天：完成人力资源管理系统软件工程文档报告，上交作品。第5章 实训总结为期二个星期的软件文档实训就要结束了，通过这些天实训，我学会了遇到问题的应急处理能力和经验，也对数据库的设计有了更深一步的了解。在设计中我们遇到了一些创建模块编写代码的问题，我们做的是一个博客系统，内容包括很多。我们一组有4个人，我们分工合作，首先我们一起完成了程序的整体框架，然后我们每人各负责两个项目的设计，经过一个星期的努力，我们完成了大半个程序，但是总是有

29、很多错误出现，有好多是些小问题，这都是我们粗心大意造成的，所以设计程序一定要仔细，不容一点的马虎。我们做好后，经过老师的讲解和改错，我们也懂得设计和运用了。同时，也让我知道了，合作的力量，如果是孤军奋战的话，我们也不能在规定时间内完成，最终达到游纫而解。同时在这次课程设计中让我们认识到做程序设计这项工作中我们要具备以下素质：很强的团队精神和协作能力。回顾起此次课程设计，至今我们仍感慨颇多。从找到题目到完成整个实验，从理论到实践，在整整半个月的时间里，可以学到很多很多的东西，同时不仅可以巩固了以前所学过的知识，而且学到了很多在书本上所没有学到过的知识。通过这次课程设计使我们懂得了理论与实际相结合是很重要的，只有理论知识是远远不够的，只有把所学的理论知识与实践相结合起来，从理论中得出结论，才能真正为社会服务，从而提高自己的实际动手能力和独立思考的能力。在设计的过程中遇到问题，可以说得是困难重重，同时在设计的过程中发现了自己的不足之处，对一些前面学过的知识理解得不够