软件文档写作实训 24Word文档下载推荐.docx
《软件文档写作实训 24Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训 24Word文档下载推荐.docx（18页珍藏版）》请在冰豆网上搜索。
1.3实训的预备知识1
1.4实训要求1
第2章软件文档及其组成2
2.1软件文档的作用及分类2
2.2软件文档所采用的标准4
2.3软件文档的主要内容4
第3章实例6
3.1兼职中介管理系统详细设计说明书实例6
3.2兼职中介管理系统可行性研究实例12
第4章实训日记16
第5章实训总结17
参考文献18
第1章实训目的与要求
1.1实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。
1、了解软件开发周期各阶段的文档。
2、掌握各文档阐述的内容及作用。
3、了解文档所采用的国际、国家等相关标准。
4、了解各文档所涉及的软件知识。
5、掌握各文档采用的描述工具。
6、具体编写出2个主要的软件文件。
1.2实训的实验环境
学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。
1.3实训的预备知识
要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。
该实训应安排在毕业设计之前进行。
1.4实训要求
第2章软件文档及其组成
2.1软件文档的作用及分类
软件文档可以分为开发文档和产品文档两大类。
开发文档包括：
《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》等。
产品文档包括：
《产品简介》、《产品演示》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》等。
一、开发文档：
1.《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。
客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。
2.《投标方案》--根据用户的功能要求，经过与招标方沟通和确认。
3.《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。
4.《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。
5.《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。
6.《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。
以《系统分析》为基础，进行详细的数据库设计。
7.《功能函数文档》--包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。
8.《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。
9.《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。
二、产品文档：
1.《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。
2.《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。
一般用Power、point或者VCD录制软件实现。
4.《功能介绍》--以《需求分析》为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。
5.《技术白皮书》--以《技术分析》为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。
6.《评测报告》--第三方权威评测报告。
包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
7.《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。
8.《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。
9.《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。
10.《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
2.2软件文档所采用的标准
参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：
按标准的类型划分和按标准的范围划分。
一、按标准的类型划分：
按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。
过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。
过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。
产品标准则涉及软件工程事务的格式和内容。
软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。
软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。
二、按标准的范围划分：
按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。
任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。
产品工程功能包括定义、生产和支持最终产品所必须的过程。
验证和确认功能是检查产品质量的活动。
技术管理功能是构造和控制产品工程的过程。
2.3软件文档的主要内容
完备的文档对软件的开发及使用起了很大的作用。
一般要求编写好十三种文档。
1、可行性分析报告
说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
2、项目开发计划
为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
3、软件需求说明书（软件规格说明书）
对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
是用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，是实施开发工作的基础。
4、概要设计说明书
是概要设计阶段的工作总结。
主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。
5、详细设计说明书
着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
6、用户操作手册
详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。
7、测试计划
包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围。
8、测试分析报告
测试计划的执行情况，对测试结果的分析，提出测试结论。
9、开发进度月报
按月提交的项目进展情况报告。
10、项目开发总结报告
项目完成以后，总结实际执行情况。
如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。
11、软件维护手册
主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。
12、软件问题报告
记录软件出现问题的日期、发现人、状态、问题所属模块，为软件修改提供准备文档。
13、软件修改报告
软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、提交审批。
第3章实例
3.1兼职中介管理系统详细设计说明书实例
详细设计说明书（GB8567——88）
1、引言
1.1编写目的
本说明书是指导开发者如何实现软件功能的编写，使得软件的大致模型得以展现，并且跟好的维护跟新。
它的阅读人员是软件编程者和相关开发者。
1.2项目背景
系统名称：
兼职中介管理系统
开发者：
Jzhui、Lqmao、Qchen、Gcye
详细设计的原则和方法：
项目整体结构清晰，按照概要设计的结构来进行详细设计。
系统详细设计后容易扩展，降低对其他模块的耦合性。
详细设计要做到可操作性，使读者能清楚所要实现的功能，以及如果去实现。
粒度设计到方法。
不具体设计到方法内的伪代码。
1.3术语和缩写
术语描述性定义
Entity:
实体
BLL：
业务逻辑层
UserProfile:
用户的详细信息
ReferPeople:
家庭成员
Recommendation:
推荐
1.4参考资料
a.林鹏.PC游戏编程.重庆.第一版.北京大学出版社.2002.76-99
b.覃征.程序设计方法与优化.第一版.西安交通大学出版社.2004.41-55
c.黄嘉辉.VB与Internet程序设计.第一版.北京:
科学出版社.2003.33-79
2、程序系统的结构
3、登录模块设计说明
从本章开始，逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3.1程序描述
（1）程序目的：
登录和注册功能是系统必须具备的功能之一，注册后，用户才可以在系统上以登录者的身份发表信息；
（2）特点：
该窗体在设计上尽量的符合人们的使用习惯，并且在出现用户名冲突的的情况下，有相应的提示信息输出。
菜单的设计应在两个方面考虑：
使用上，在使用上应尽量让用户感觉到方便又符合人们的习惯。
分类要明确、细致；
外观上，应考虑使用当今比较流行的菜单样式，显得比较华丽。
尽量的能让用户可以按照自己的意愿去改变菜单的样式，在选项里去设置。
3.2功能
登录：
接受用户登录请求，验证用户输入的用户名、密码和验证码，转到管理页面。
用户、密码→验证→输出页面。
3.3性能
本系统经过了全面的测试能有超强的负载能力，由于在开发前比较好的策划，以及在开发过程中比较频繁的整合便得此系统有很好的兼容性。
3.4输入项
用户名：
字符串型
密码：
验证码：
yzm
3.5输出项
输出整个登录页面
3.6算法
VB连接sql数据库。
OptionExplicit
DimconnAsADODB.Connection
DimrsAsADODB.Recordset
PrivateSubForm_Load（）
Setconn=NewADODB.Connection
Setrs=NewADODB.Recordset
conn.ConnectionString="
Provider=SQLOLEDB.1;
DataSource=J:
\ProgramFiles\MicrosoftSQLServer\MSSQL10.MSSQLSERVER\MSSQL\DATA\stc.mdf;
PersistSecurityInfo=true;
UserID=sa;
InitialCatalog=stc"
conn.Open
rs.Open"
student"
conn,,adCmdTable
'
rs=Execute（"
select*fromstudent"
）
Setmy.DataSource=rs
rs.Close
conn.Close
EndSub
3.7流程逻辑
3.8接口
ADO一种程序对象，用于表示用户数据库中的数据结构和所包含的数据。
在MicrosoftVisualBasic编辑器中，可以使用ADO对象以及ADO的附加组件（称为MicrosoftADOExtensionsforDLLandSecurity（ADOX））来创建或修改表和查询、检验数据库、或者访问外部数据源。
还可在代码中使用ADO来操作数据库中的数据。
3.9储存分配
本组件内所依赖的变量、结构要求全部在组件元素内申明。
3.10测试计划
见测试计划说明书。
4、查询模块设计说明
其余模块的程序的内容与本模块基本相同，所以只介绍本模块。
4.1程序描述
前提：
当客户会员想查询求职信息信息时，会员必须已经登入该系统。
处理：
对于招聘者查询求职需求信息，可以查询满足一定条件的需求信息，对于求职者查询招聘信息时，可以查询满足一定条件的招聘信息（如查询工资满足一定条件的，地址满足一定条件的等等）。
系统将显示查询结果。
4.2功能
4.3性能
系统具有输入出错处理能力，提示选择功能。
4.4输入项
招聘查询：
按地址：
输入地址，下拉选框输入
按学历：
输入学历，下拉选框输入
按工资：
输入数值（1000—2000、2000—…），下拉选框输入
按假期：
输入时间范围，下拉选框输入
求职查询：
4.5输出项
查询招聘信息返回结果部分：
公司图片，公司地址，学历，工资，招聘者ID，招聘者姓名等。
查看求职信息结果输出部分：
求职者ID，求职者姓名等等。
4.6算法
SQL语言
Where子句中加上所输入的相关条件
4.7流程逻辑
4.8接口
数据库接口：
HZ_table,HW_table,KH_table5.9存储分配。
4.9注释设计
程序前：
用/**…*/注释
程序中：
/*…*/多行注释
//…单行注释
4.10限制条件
查询信息前，需要会员首先登录到该系统。
4.11测试计划
4.12尚未解决的问题
系统开发结束时所有问题都已解决。
3.2兼职中介管理系统可行性研究报告实例
可行性研究报告（GB8567——88）
1、引言
随着我国市场经济的快速发展和人们生活水平的不断提高，简单的中介服务已经不能满足人们的需求。
如何利用先进的管理手段，提高中介服务的管理水平，是当今社会的一个重要课题。
在之前的中介管理过程中，各地往往采用的是通过粘贴板的方式用用户贴出本地求职的情况，不仅不便于用户快速的查询情况，而且手工操作难免带来各种误差和错漏，尤其是在数据信息处理工作量大时容易出错；
数据繁多时，容易丢失，且不易查找，出错后又不易修改。
基于以上问题，有必要建立中介管理系统，使管理工作规范化，系统化，程序化，避免的随意性，提高信息处理的速度和准确性，能够及时、准确、有效的查询、修改基本信息，并能根据用户的不同需要，准确，迅速找到合适的职位，而且管理者也迅速的统计出本月情况等。
文档阅读对象：
兼职中介管理系统的用户、测试人员。
2.2背景
通过数据我们小组认为，提出编写兼职中介管理系统这个方案是非常合理的。
让大学生在学习的同时可以锻炼自己。
为了满足兼职中介管理系统能够方便的简单的管理与实用的目标。
兼职中介管理系统将分为窗口与后台数据库管理两个部分。
制作漂亮的窗口界面将由我们小组自己去图书馆学习方法。
3.定义
列出本文档中所用到的专门术语的定义和缩写词的原意、容易引起混淆的概念等。
Part-timeintermediarymanagementsystem兼职中介管理系统。
4.参考资料
a.张树兵.SQLSERVER2000.第一版.清华大学出版社.1999.78-112
b.吕青松.VisualBASIC语言编程.第一版.宇航出版社.1999.342-351
c.耿卫东.计算机游戏程序设计.第一版.电子工业出版社.2005.54-63
d.覃征.程序设计方法与优化.第一版.西安交通大学出版社.2004.41-55
2、可行性研究的前提
2.1要求
a.功能：
招聘信息展示、求职需求展示、招聘者登录注册、求职者注册、房屋求职招聘信息。
b.性能：
软件采用人机对话的操作方式，界面设计美观友好，信息查询灵活，方便，快捷，准确，数据存储安全可靠。
并且实时，快速，准确提供需求信息，组大限度地实现了易维护性和易操作性，运行稳定，安全可靠。
c.数据的来源：
招聘者主动提交的所有招聘相关信息。
2.2目标
实现一人一机即可完成招聘求职的业务，节省了人力资源和业务处理的时间。
通过与数据库连接，使数据更加可开，准确，提高了业务处理的质量，节约了成本。
通过与Internet连接，为租户提供了一个友好的交流平台，使求职者足不出户就能了解自己的求职信息。
公司管理层通过系统可随时了解到求职者动态及公司的业务信息，为管理者提供了决策依据。
业务人员在处理业务时能在系统中搜索到需要的有关信息，能为求职者提供更全面的信息，提高了服务的质量和工作的效率。
2.3条件、假定和限制
建议开发软件运行最短寿命为五年，进行系统方案选择比较的期限为一个月。
开发系统的经费自己筹集。
未经作者的允许，禁止非法传播，复制，违者追究发了吧责任，后果自负。
在主频为2.53GHZ的CPU，具有显卡，内存在1GB以上的个人电脑上开发系统。
使用SQL2000开发数据库，从容编写程序代码。
本软件在装有windowsXP操作系统的环境中运行。
可利用的信息和资源：
建议开发软件的投入最迟时间是2012年1月1日。
2.4进行可行性研究的方法
建议本系统的研究主要集中在是否能够为求职招聘的日常工作带来便利，能否减轻工作量，能否处理大量数据，最终提高工作效率。
2.5评价尺度
主要尺度：
费用较低。
各项功能的优先次序按照用户的需求而定，开发的时间较短，使用起来方便易懂。
3、对现有系统的分析
3.1处理流程和数据流程
现有系统的基本的处理流程和数据流程并不完善。
3.2工作负荷
现有系统所承担的工作只能实现档案管理的简单功能，已无法适应目前工作中处理大量数据的功能。
3.3费用开支
由于现有系统的工作负荷超载，在现有的系统上投入的人力，设备，空间，材料等与其他的一系列支持性服务越来越大，导致公司费用支出巨大，不利于公司的盈利。
3.4人员
现有系统需要档案管理用2人，熟悉Windows操作系统的业务员2人，财务人员3人和统计人员2人。
3.5设备
局域网内的所有计算机，打印机等。
3.6局限性
只有物业公司或房屋中介工作人员才能与系统进行交互，租户要了解租房有关信息，必须通过业务人员才能得到有关信息。
且当前系统无法对数据进行智能管理与备份，所以需要设计完全适合当前使用的新系统。
4、所建议的系统
4.1所建议系统的说明
a.性能：
可以实现对用户的登录，查询，注册，管理，显示等功能。
b.输出：
输出房主的信息，定时的招聘的信息和定时的显示求职者的信息
c.输入说明系统的输入，包括数据的来源，类型，数量，数据的租住以及提供的频度；
输入的来源包括注册时所提供的信息和用户的信息改变的时候所提交的信息它们为文本的形式每隔两天提供定时的更新各种信息。
4.2处理流程和业务流程
业务员登录后，查看当前已登记的招聘信息，已招聘的招聘信息，求职的求职者信息。
有新招聘者求职时，及时登记新招聘者信息，并告知相关信息。
招聘者缴费时，将缴费记录计入系统，并打印缴费单。
查看招聘者缴费信息，发现有欠费3月以上的招聘者，打印催款费单通知并发送邮件给招聘者提醒及时缴费。
月底可通过系统打印所以财务报表，方便管理层了解相关信息。
月末，系统自动生成收费日记账和数据统计报表，财务部生成财务报表上交经历办公室，供管理层做出决策。
系统能打印招聘者清册，以便一览求职者信息。
招聘者登录系统后，能查看未招聘到的职位信息和自己招聘的相关信息，可以查看缴费历史记录和欠费信息。
4.3改进之处
增加了对于招聘求职系统在后期的收费问题，增加了系统对这个方面的管理，比如说按照什么标准来收费，以及其时间的限制等等所做的限制。
4.4影响
4.4.1对设备的影响
若当前设备CPU不低于CPUPIII,内存不低于256KB，则对当前设备无影响。
但建议使用最先进的设备来配合系统的技术。
4.4.2对软件的影响
若当前系统版本不低于Windows2000,则对软件无影响。
4.4.3对用户的影响
要求用户单位操作人员熟悉软件运行的基本环境Windows操作系统。
4.5技术方面的可能性
就目前使用的软硬件设备和开发技术来说功能目标能达到，为满足需求，需要软件工程师2人，系统分析师1人和系统测试员1人，在规定的2个月期限内能够开发完成。
5、可选择的其他系统方案
本系统是为了改善原有系统在经费支出高和低效率的缺点的，所以新系统一经使用在经费支出方面一定能得到很好的改善，用户在使用了新系统后只需要花一定资金购买一部分计算机与阮籍就能实现自动化。
6、社会因素方面的可行性
本软件系统操作简单，运行方便，用户一般不会出现使用上的困难。
且用户单位原来就使用了系统，能够很好的使用新系统。
现在个人电脑以及很普及了，越来越多的人接受并开始以来网上业务，招聘者能够使用该系统也是完全有可能的。
7、结论
经过对可行性研究报告的研究，我以为我们的软件开发在经济上和技术上都是完全符合客户要求的，所以能够立即执行软件的开发，并达到客户的目标。
第4章实训日记
第1天：
选择题目。
我选择的题目是兼职中介管理系统。
第2-3天：
去图书馆查阅了大量关于兼职中介管理系统软件工程文档的相关资料并在网上查找了一些关于软件工程设计的资料，要对每个细节要进行全面的设计和说明。
第4-6天：
整理从图书馆和网上收集来的资料和程序代码，分析模块功能，阅读软件工程书籍，对软件工程文档的撰写有了一定了解，了解对软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查资
升级会员 