软件文档写作实训

《软件文档写作实训》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、实用标准文案实训任务及评语院（系）：软件学院教研室：软件教研室学号学生姓名专业班级实训题目网上购物系统软件文档实训任务实训任务及要求：1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，

2、组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩：指导教师签字：年月日精彩文档实用标准文案目录第1章实训目的与要求11.1实训目的11.2实训的实验环境11.3实训的预备知识11.4实训要求1第2章软件文档及其组成22.1软件文档的作用及分类22.1.1软件文档的作用22.1.2软件文档的分类32.2软件文档所采用的标准42.3软件文档的主要内容5第3章实例63.1软件需求文档63.2用户手册8第4章实训日记15第5章实训总结16参考文献17精彩

3、文档实用标准文案第1章实训目的与要求1.1实训目的本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。1.2实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3实训的预备知识要求学生修完全部专科

4、所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。精彩文档实用标准文案第2章软件文档及其组成2.1软件文档的作用及分类2.1.1软件文档的作用1．管理依据在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的责任以及该

5、部门效率的重要性。开发文档规定若干个检查点和进度表，使管理者可以评定项目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。2．任务之间联系的凭证大多数软件开发项目通常被划分成若干个任务，并由不同的小组去完成。学科方面的专家建立项目，分析员阐述系统需求，设计员为程序员制定总体设计，程序员编制详细的程序代码，质量保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功能。这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，

6、因而，任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规定了一些正式文档。分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说明，等等。3．质量保证那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明；必须制订测试计划和测试规程，并报告测试结果；他们还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。这些文档的提供可满足质量保证人员和审查人员上述工作

7、的需要。4．培训与参考软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作，以及为了达到他们的各自的目的，如何使用系统。5．软件维护支持维护人员需要软件系统的详细说明以帮助他们熟悉系统，找出并修正错误，改进系统以适应用户需求的变化或适应系统环境的变化。6．历史档案软件文档可用作未来项目的一种资源。通常文档记载系统的开发历史，可使有关系统结构的基本思想为以后的项目利用。系统开发人员通过审阅以前的系统以查明什么部分已试验过了，什么部分运行得很好，什么部分因某种原因难以运

8、行而被排除。良好的系统文档有助于把程序移植和转移到各种新的系统环境中。精彩文档实用标准文案2.1.2软件文档的分类下面给出软件文档主要类型的大纲，这个大纲不是详尽的或最后的，但适合作为主要类型软件文档的检验表。而管理者应规定何时定义他们的标准文档类型。软件文档归入如下三种类别：a)开发文档——描述开发过程本身；b)产品文档——描述开发过程的产物；c)管理文档——记录项目管理的信息。1.开发文档开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的