软件文档写作实训

实用标准文案精彩文档实训任务及评语院（系）：软件学院教研室：软件教研室学号学生姓名专业班级实训题目网上购物系统软件文档实训任务实训任务及要求：1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出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实用标准文案精彩文档第1章实训目的与要求1.1实训目的本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。1.2实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。实用标准文案精彩文档第2章软件文档及其组成2.1软件文档的作用及分类2.1.1软件文档的作用1．管理依据在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的责任以及该部门效率的重要性。开发文档规定若干个检查点和进度表，使管理者可以评定项目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。2．任务之间联系的凭证大多数软件开发项目通常被划分成若干个任务，并由不同的小组去完成。学科方面的专家建立项目，分析员阐述系统需求，设计员为程序员制定总体设计，程序员编制详细的程序代码，质量保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功能。这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因而，任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务的联系规定了一些正式文档。分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说明，等等。3．质量保证那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明；必须制订测试计划和测试规程，并报告测试结果；他们还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。这些文档的提供可满足质量保证人员和审查人员上述工作的需要。4．培训与参考软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作，以及为了达到他们的各自的目的，如何使用系统。5．软件维护支持维护人员需要软件系统的详细说明以帮助他们熟悉系统，找出并修正错误，改进系统以适应用户需求的变化或适应系统环境的变化。6．历史档案软件文档可用作未来项目的一种资源。通常文档记载系统的开发历史，可使有关系统结构的基本思想为以后的项目利用。系统开发人员通过审阅以前的系统以查明什么部分已试验过了，什么部分运行得很好，什么部分因某种原因难以运行而被排除。良好的系统文档有助于把程序移植和转移到各种新的系统环境中。实用标准文案精彩文档2.1.2软件文档的分类下面给出软件文档主要类型的大纲，这个大纲不是详尽的或最后的，但适合作为主要类型软件文档的检验表。而管理者应规定何时定义他们的标准文档类型。软件文档归入如下三种类别：a)开发文档——描述开发过程本身；b)产品文档——描述开发过程的产物；c)管理文档——记录项目管理的信息。1.开发文档开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述（程序逻辑、程序间相互关系、数据格式和存储等）。开发文档起到如下五种作用：a)它们是软件开发过程中包含的所有阶段之间的通信工具，它们记录生成软件需求、设计、编码和测试的详细规定和说明；b)它们描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做；c)它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具；d)它们形成了维护人员所要求的基本的软件支持文档。而这些支持文档可作为产品文档的一部分；e)它们记录软件开发的历史。基本的开发文档是：——可行性研究和项目任务书；——需求规格说明；——功能规格说明；——设计规格说明，包括程序和数据规格说明；——开发计划；——软件集成和测试计划；——质量保证计划、标准、进度；安全和测试信息。2.产品文档产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。产品的文档起到如下三种作用：a)为使用和运行软件产品的任何人规定培训和参考信息；b)使得那些未参加开发本软件的程序员维护它；c)促进软件产品的市场流通或提高可接受性。产品文档用于下列类型的读者：——用户——他们利用软件输入数据、检索信息和解决问题；——运行者——他们在计算机系统上运行软件；——维护人员——他们维护、增强或变更软件。产品文档包括如下内容：——用于管理者的指南和资料，他们监督软件的使用；——宣传资料通告软件产品的可用性并详细说明它的功能、运行环境等；实用标准文案精彩文档——一般信息对任何有兴趣的人描述软件产品。基本的产品文档包括：——培训手册；——参考手册和用户指南；——软件支持手册；——产品手册和信息广告。3.管理文档这种文档建立在项目管理信息的基础上，诸如：——开发过程的每个阶段的进度和进度变更的记录；——软件变更情况的记录；——相对于开发的判定记录；——职责定义。这种文档从管理的角度规定涉及软件生存的信息。2.2软件文档所采用的标准1.根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：(1)国际标准:ISO国际标准化组织(2)国家标准:GB中国ANSI美国BS英国JIS日本(3)行业标准:IEEE(4)企业(机构)标准:IBM(5)项目(课题)标准:CIMS2.基本标准包括：(1)软件工程术语,标准号为GB/T11457-1989；(2)信息处理——数据流程、程序流程图、系统结构图、程序网络图、系统资源图的文件编制符号及约定,标准号为GB/T1526-1989；(3)软件工程标准分类法,标准号为GB/T15538-1995；(4)信息处理——程序构造及其表示法的约定,标准号为GB/T13502-1992；(5)信息处理——单命中判定表规范，标准号为GB/T15535-1995(ISO5806)；(6)信息处理系统——计算机系统配置图符号及其约定，标准号为GB/T14085-1993(ISO8790)。3.开发标准包括：(1)信息技术——软件生存期过程，标准号为GB/T8566-1995；(2)软件支持环境，标准号为GB/T15853-1995；(3)信息处理——按记录组处理顺序文卷的程序流程，GB/T15697-1995(ISO6593)；(4)软件维护指南，标准号为GB/T14079-1993。4.文档标准包括：(1)计算机软件产品开发文档编制指南，标准号为GB/T8567-1988；(2)计算机软件需求说明编制指南，标准号为GB/T9385-1988；(3)软件文档管理指南，标准号为GB/T16680-1996。5.管理标准包括：(1)计算机软件配置管理计划规范，标准号为GB/T12505-1990；(2)信息技术——软件产品评价质量特性及其使用指南，标准号为GB/T16260-1996；(3)计算机软件质量保证计划规范，标准号为GB/T12504-1990；实用标准文案精彩文档(4)计算机软件可靠性和可维护性管理，标准号为GB/T14394-1993。2.3软件文档的主要内容本软件文档是网上购物系统软件文档。网上购物系统软件文档包括：网上购物系统操作手册、网上购物系统测试计划、网上购物系统概要设计说明书、网上购物系统可行性分析报告、网上购物系统需求说明书、网上购物系统详细设计说明书、网上购物系统项目计划、网上购物系统项目总结报告、网上购物系统用户手册。首先，网上购物系统分为以下几个功能：系统设置、商品供应商信息管理、商品信息管理、商品管理、销售管理、销售数据查询。我在这个管理系统软件文档所作的内容为：需求分析：需求分析是指对要解决的问题进行详细的分析，弄清楚问题的要求，包括需要输入什么数据，要得到什么结果，最后应输出什么。可以说，在软件工程当中的“需求分析”就是确定要计算机“做什么”。虽然功能需求是对软件系统的一项基本需求，但