软件文档写作实训(共18页).doc

精选优质文档-倾情为你奉上辽 宁 工 业 大 学 软件文档写作 实训报告题目： 教师信息管理系统软件文档 院（系）: 软件学院 专业班级: 学 指导教师: 起止时间: 2012.11.26-2012.12.02 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号实训题目 教师信息管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日专心-专注-专业目 录第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.便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。文档在各类人员、计算机之间的多种桥梁作用中看出：既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。 分类：软件文档从形式上来看，大致可分为两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。软件文档的编制，可以用自然语言，特别设计的形式语言，介于两者之间的半形式语言(结构化语言)，各类图形表示。表格来编制文档。文档可以书写，也可以在计算机支持系统中产生，但它必须是可阅读的。按照文档产生和使用的范围，软件文档大致可分为三类： 1.开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2.管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一砦工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。 3.用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。2.2软件文档所采用的标准 ISO标准是International Organization for Standardization的英文缩写,即国际标准化组织。它的宗旨是在全世界促进标准化及有关活动的发展，以便于国际物资；交流和服务，并扩大知识、科学、技术和经济领域中的合作。 GB/T 85662006范围根据GB/T 85662001信息技术软件生存周期过程的规定，主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。本标准原则上适用于所有类型的软件产品的开发过程和管理过程。使用者可根据实际情况对本标准进行适当剪裁(可剪裁所需的文档类型，也可对规范的内容作适当裁剪)。软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的内部文档(开发文档)两类。供方应提供的文档的类型和规模，由软件的需方和供方在合同中规定。2.2 软件文档的主要内容软件文档主要分为开发文档和产品文档其中开发文档又分为：功能要求投标方案和需求分析技术分析系统分析数据库文档功能函数文档界面文档编译手册QA文档项目总结等而产品文档则分为：产品简介产品演示疑问解答功能介绍技术白皮书评测报告安装手册使用手册维护手册用户报告销售培训等。其中主要的有：1、功能要求：来源于客户要求和市场调查，是软件开发中最早期的一个环节。2、需求分析包括产品概述、主要概念、操作流程、功能列表和注意事项系统环境等。3、技术分析包括技术选型、技术比较、关键技术问题的解决、技术风险、等。4、系统分析：包括功能实现，模块组成、函数接口、数据字典、开发需要考虑问题等。5、数据库文档：包括数据库名称、表明、字段名、字段说明、字段数值计算公式等。6、功能函数文档：包括变量名、功能、函数名、参数、如何调用、备注、注意事项等。7、项目总结：包括项目简介、项目功能列表、项目结构特点、对以后的项目建议等。第3章 实 例3.1 教师信息管理系统实例输入信息个人资料授权课程特殊补助收入总汇提示错误登录系统选择要进行的操作输入密码码教师信息管理职称信息管理帐号管理退出提示错误设置账号删除查询添加退出可行性研究报告1引言1.1编写目的 可行性研究的目的是为了对问题进行研究，以最小的代价在最短的时间内研究问题是否可以得到解决。经过对此项目进行详细调查研究，初拟系统实现报告，对软件开发中将要面临的问题及其解决方案进行初步设计及合理安排。明确开发时间精力风险。编码可行性研究报告的目的是为了对本系统的可行性进行一下探讨，论证实现本项目的可能性，和一些前期的准备工作及工作条件，并且为下一步设计打下铺垫.1.2背景待开发的软件系统的名称：教师信息管理系统。本项目开发小组人员：杨娜，白晋伟，庞珊珊，齐峰，文烈用户：各大院校1.3定义Teacher Manage:教师管理。1.4参考资料学生管理信息系统公司职员管理系统实用软件文档写作2可行性研究的前提2.1要求A.主要功能：为教师信息管理员提供查看各方面信息的服务，从而进行全局掌控的功能； 为信息管理人员提供查看和管理教师信息的变动便于记录，管理教师在校的活动情况的功能；为学生提供查看教师的精品课程的功能。B.性能：管理人员必须准确无误的登记教师的信息，并且快速地传送至总服务器，对教师 的信息要及时更新，并且应该达到1000人同时能正常快速地访问服务器。C.输出：数据准确，完整，详细D.输入：方便，简介，迅速E.安全与保密要求：非信息管理人员无法使用此系统，各部门的管理人员拥有与其部门相对应模块的使用权限，无法越权操作；主管有权查看各部门信息，但无法随意修改；F.完成期限：预计一个月2.2目标 为各高校的教师构建一个完整的教师信息记录平台，以便快速的查阅教师的信息和管理教师在校的情况。在开发过程中做到： a.最大程度的减少资金与人员的利用； b.在设计系统处理速度时做到考虑周全使系统的整体运行速度全面提高； c.在进行管理员操作时限制条件应准确无误； d.在人员利用率方面，使用最少的开发人员完成系统开发。2.3条件、假定和限制 a.所建议系统的运行寿命的最小值：2年； b.进行系统方案选择比较的时间：2012-11-30； c.经费、投资方面的来源：投资院校； d.硬件：SQL server 2000；运行环境：windows xp/win 7/Vista可利用的信息和资源； 系统投入使用的最晚时间：2012-12-02。2.4进行可行性研究的方法 可行性研究的方法是通过对在校的所有教师进行问卷调查登记而得到教师对此系统的信任度关注度及依赖度，以及对此系统的各种期望。通过建模分析，得出取代旧系统的新系统的功能需求，成本分析，可行性分析。2.5评价尺度收益可行：效益/成本>1技术可行：现有技术可完全承担开发任务。操作可行：软件能被信息管理工作人员快速接受3对现有系统的分析 随着社会的快速发展，教育已经成为了一个国家的标志，为保证了高水平的教学质量。为了不断提高教学质量，提高教师队伍水平，不断扩大办学规模，合学院成为国内知名、省内一流的高职学院。为保证战其实现，学院领导认识到提高教学教学管理水平的必要性，为此，建立管理信息系统，使教学管理工作规范化、制度化、程序化，促进学院管理的基础工作，提高信息处理速度和准确性，及时掌握学院内外部环境的各种信息成为关键。客户机端显示数据客户机端显示数据客户机端显示数据客户机端显示视频产生报表产生报表产生报表产生报表数据库计算机财务系建工系管理系查询请求查询，更新信息查询，更新信息查看监控录像3.1处理流程和数据流程3.2工作负荷现有系统中主要由系主任、教务员和教研室主任负责教学管理工作，具体分工如下：系主任：负责教学计划的审核、教学任务的安排、教学管理各项工作的督查。教务员：负责教学管理的各项具体工作，教学任务实现的检查、记录。教研室主任：负责教学计划的制订修订、配合系主任完成教学任务的安排。3.3费用开支3.3费用开支人员：教学管理人员多名，由学院支付工资设备：使用4台PC机、一台打印机进行教学信息处理空间：一间办公室开支以及开 支总额。3.4人员PC机维护：1人3.5设备 PC机：4台打印机：1台3.6局限性某些学院现行的管理工作存在主要问题是：1业务管理工作缺乏规范性，随意性大。2业务管理部门各自政，数据资料被职能人员独自使用，造成具体工作对个别人员的依赖性大。3部门之间交流信息少，信息渠道不畅，工作不易协调。4数据处理手工操作，工作量大，出错率高。5学院领导对整个学校的各项管理信息掌握不及时、不准确，影响决策。4所建议的系统4.1对所建议系统的说明教师信息的管理系统的终端是安装了windows操作系统的PC机，主要任务是向信息管理数据库的主服务器传送数据和查看主服务器的数据。信息修改管理方面，管理人员将教师的错误信息通过PC机输入到主服务器中。教师查看是教师通过Internet访问服务器，输入查询的部分信息到主服务器中，主服务器将符合查询的信息资料服务器提取出来显示在终端机上，达到查看的目的。管理员可以通过PC机向主服务器发送查看信息的请求，主服务器会将管理员想查找的信息发送到你的PC机上。学生访问管理方面，学生访问教师管理系统只有访问和查看教师信息的权限 ，学生向服务器发送箱要查询教师的部分信息，主服务器将符合条件的教师信息提取出来最终显示在终端上。4.2处理流程和数据流程4.3改进之处 教师信息管理系统是基于网络的新型系统，系统规模虽小，但功能齐全。实现了教学管理各项信息的计算机处理，便教学管理人员和学生进行查阅，实现信息的共享。4.4影响4.4.1对设备的影响 由于采用C/S结构，需要服务器一台，可以另购，或直接使用学院现有的网络中心的服务器。客户机可以使用办公室现有PC机。4.4.2对软件的影响需要在服务器中安装SQL Server服务器。客户端无要求。4.4.3对用户单位机构的影响本系统的使用，只需要教学管理人员掌握基本的计算机操作即可。4.4.4对系统运行过程的影响无要求。4.4.5对开发的影响需要教务员提供系统所需原始数据。4.4.6对地点和设施的影响无要求。4.4.7对经费开支的影响本系统所需要的硬件和软件环境可以使用学院现有的资源，软件开发由计算机系组织专业技术人员2人进行开发，学院只需要2人开发工资5000元。4.5局限性 该学院现行的管理工作存在主要问题是：1业务管理工作缺乏规范性，随意性大。2业务管理部门各自政，数据资料被职能人员独自使用，造成具体工作对个别人员的依赖性大。3部门之间交流信息少，信息渠道不畅，工作不易协调。4数据处理手工操作，工作量大，出错率高。5学院领导对整个学校的各项管理信息掌握不及时、不准确，影响决策。4.6技术条件方面的可行性1）.在当前的限制条件下，该系统的功能目标能达成2）.开发这个软件并不需要大量的工作人员，而且对工作人员的能力要求没那么高，所以 在工作人员的效率和质量方面是没有问题的3）.由于该软件并不是特别难，所以在一定数量的工作人员下，并不会花费太多的时间。5可选择的其他系统方案5.1可选择的系统方案1 在查询的时候可以添加一些条件不符合的输入，我们可以添加一些词语联想的功能来辅助进行查询教师的信息。6投资及效益分析6.1支出6.1.1基本建设投资 网络设备：1200 辅助配置：100 共计：13006.1.2其他一次性支出硬件设备：计算机，打印机，5006.1.3非一次性支出经常性支出： 人工费用： 5（人）*1（月）*500（元）=2500 其他不可预知性的额外支出： 300 支出共计：28006.2收益6.2.1一次性收益0元6.2.2非一次性收益经常性收益（按银行利率：1%）：减少员工5人（500元/人）五年收益：5人*800元/人=2500元。 经常性收益共计 ： 1万6.2.3不可定量的收益不定量收益；因服务质量提高增加的用户10%：1万；收益共计：3万6.3敏感性分析系统设计周期为五年，估计最长可达9年；处理速度：一般输入速度<3秒；说句查询速度：<5秒；7社会因素方面的可行性7.1法律方面的可行性所有软件都选用正版；所有技术资料都由提出方保管；合同制定确定违约责任。7.2使用方面的可行性普通的管理员都能熟练掌握系统的管理工作；领导等管理阶层能顺利方便的查到一切教师的变动和教师的授课情况以及各个教师的福利及工资等。8结论由于投资效益比远大于100%, 技术、经济、操作都有可行性， 能够有效的节省人力物力，可以进行开发。3.2教师信息管理系统实例概要设计说明书1引言1.1编写目的为明确教师信息管理系统的系统结构、安排项目规划与进度、制定详细测试计划、组织软件开发与测试，特撰写本文档。本文档供项目经理、设计人员、开发人员参考。1.2背景开发软件名称：教师信息管理系统项目任务提出者：辽宁工业大学软件学院软件工程专业项目开发者：杨娜，白晋伟，庞珊珊，齐峰，文烈用户：各所院校实现软件者：杨娜，白晋伟，庞珊珊，齐峰，文烈项目与其他软件，系统的关系：该系统需要在学生成绩管理系统，学生选课系统等已有系统直接复制数据，所以在定义数据时要与已有系统相兼容。本系统采用VB作为前台，Microsoft SQL Server 2000作为后台数据库。 1.3定义Teacher Manage:教师管理。1.4参考资料学生管理信息系统公司职员管理系统实用软件文档写作 编号hust_FSR：可行性研究报告 镇祎编号 hust_xiangmujihua：项目计划说明书 汪瑶 编号 hust_xuqiuguifan需求规范说明书 欧高炎2总体设计2.1需求规定输入功能性能要求：教师信息的录入要符合客观事实输出功能性能要求：所有教师信息以及学生选课的信息应符合实际要求处理的功能性能要求：教师授课与教师信息应相匹配2.2运行环境SQL server 2000；运行环境：windows xp/win 7/Vista可利用的信息和资源； 系统投入使用的最晚时间：2012-12-02。2.3基本设计概念和处理流程输入信息个人资料授权课程特殊补助收入总汇提示错误登录系统选择要进行的操作输入密码码教师信息管理职称信息管理帐号管理退出提示错误设置账号删除查询添加退出针对本系统的教务管理人员、学生、教师三种不同的角色，系统的处理流程如下图所示： 图2.1教务管理人员登录时的系统流程图2.4结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.5功能器求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：程序1程序2程序n功能需求1功能需求2功能需求n2.6人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。2.7尚未问决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。3接口设计3.1用户接口说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。3.2外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。3.3内部接口说明本系统之内的各个系统元素之间的接口的安排。4运行设计4.1运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。4.2运行控制说明每一种外界的运行控制的方式方法和操作步骤。4.3运行时间说明每种运行模块组合将占用各种资源的时间。5系统数据结构设计5.1逻辑结构设计要点给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。5.2物理结构设计要点给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。5.3数据结构与程序的关系说明各个数据结构与访问这些数据结构的形式:6系统出错处理设计6.1出错信息用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。6.2补救措施说明故障出现后可能采取的变通措施，包括：后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。6.3系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系，可采用如下的矩阵图的形式； 第4章 实训日记一周紧张的实习过去了，在这期间我学会了软件文档的编写，并且对前面学过的许多课程有了更为深刻的理解，让我真正体会到了软件开发的整个过程真是不易。整个过程是我受益匪浅，综合起来，总结如下：第一，做事不能够急于求成，越是急于求成心境就越是安静不下来。这样为课题的完成设置了许多的阻碍。而且，由于在开发系统前考虑的问题时比较片面，上手操作时相对来说就较盲目。给后面的开发带来了很大的不便。但经过查一些相关资料，将问题一一解决了，使得后来的工作才得以顺利进行。第二，在对理论知识的熟悉上也有要求，这也无疑是开发进度提升的难点。由于以前在学习过程中只是独立的编制过一些较为简易的程序，其实现的功能也是有限，从而要求对语言的熟悉程序不高。然而这次设计，不但难度大时间短，而且还要求对一些算法比较熟悉，否则将延迟工作速度，必须停下来再去学习，后因时间问题，本系统还有一些不尽如意之处。通过这周的课程设计，我认识到了自己许多方面的不足。在编程过程中不仔细是很麻烦的，这将让费许多的时间。这次实习给我敲响了警钟以后一定要注意，要更加细心。总的来说，这次的实习设计为我进入下一个成长阶段奠定了基础。让我对几年来所学的专业课有了更为深刻的认识，使知识得到了融会贯通，得到了比以往学习任何一门课都有大的提高和进步。这次实习设计虽说不能堪称完美，但我会在以后的时间里尽量的完善它，不断的对它进行升级，解决系统可能出现的问题。第5章 实训总结此次所实训内容是编写开发教师信息管理系统文档，在老师指导、安排下，每组5人，小组内分工明确。     在分组的时候我们将题目分为五段：详细设计与需求分析，概要设计+可行性分析，数据库设计+操作手册，详细设计+测试分析。我组的教师信息管理系统在可行性分析阶段我们用了2天，通过我们在对原有系统的调查，很快我们完成了可行性分析报告的编写,可行性分析报告的目的是确定问题是否值得去解决,这个阶段我们分析的很完美。其次进入项目开发阶段,那天早上是项目立项，这部分主要是工作任务的分解与人员分工和干特图、进度分解和费用预算。我们用到了project制作干特图，每个组员齐动手，在计划的时间内，我们完成了项目开发计划书的编写。再次系统设计阶段，系统分析怎么去做，这部分是对在需求分析阶段提取出来的类的具体化，对属性、方法和对象。我们每个人都做的很好，我们分配的任务也能及时完成，每个人努力工作，都会和成绩成正比的，你付出多少，将来回报多少。我们在这次实习中，身有体会。最后是测试阶段，这部分时间就是检验我们几天的工作的时候了，系统必须通过黑合、白合测试，才能给与用户交付。上面的4份文挡只是对系统的一个分析，看不到成果，你的分析很好，但是代码实现不行，最终还是失败的。所以我们努力实现了系统的功能，给老师演示了我们的成果，并且编写了测试分析报告。通过这次实训，我首次接触了软件文档，把书本的理论和实践联系起来，有利于巩固所学理论，为以后走向工作岗位打下一个初步的基础。我们的辅导老师，对我们很认真，每天和我们在一起时，总是给我们指导文档，指明错误，并勉励我们继续努力工作下去，使我们在工作中受益非浅。在这里，我也非常感谢老师，对我们这几天天来关心，越严格要求我们，说明越对我们负责。实习全部结束，但是我们知道我们的实力，在软件方面还是不行的，还需要努力。虽然每个软件报告都写的很完美，实际上问题很多，我们要认识到自己的不足，不要盲目的自大，要以一种平和的心态面对将来的挑战。我们是计算机专业，软件是离不开的，在以后实际工作中还会遇到这样那样的问题，我们的路还很长，需要虚心学习，为了以后打下基础的。参考文献1肖刚.使用软件文档写作.清华大学出版社.20052张逸著.软件设计精要与模式.北京电子工业出版社.20103郭克华.软件安全实现.清华大学出版社.20104吴菊.高校教师业务档案管理之我见.2006. 5李国忠, 谭冠政.基于B/ S模式教师信息管理系统的设计与实现.2007.6李龙澍,郑诚等编著.软件工程课程设计.机械工业出版社.2010 7张海藩.软件工程导论.清华大学出版社.2007.8万建成.软件体系结构的原理.科学出版社.2007.9卢雷.使用软件体系结构组成与应用.科学出版社.2008.10郑人杰.实用软件工程.北京大学出版社.2011.11(美)普雷斯曼.软件工程实践者的研究方法.机械工业出版社.2004