某软件开发公司实用软件工程文档资料汇编(编辑修改稿)

某软件开发公司实用软件工程文档资料汇编(编辑修改稿)内容摘要：

点列表 （ 3）主要接口列表 （ 4）本软件项目与其他软件项目之间的关系 （ 5）项目实施方面的限制等内容 项目的使用对象（ Project Reader） 在本章节中，要识别出顾客与最终用户，对顾客与最终用户的情况要有简单描述，如最终用户的教育水平、技术水平及本系统的使用频度等。 3．项目组织 （ Project Organization） 项目组织是为开发项目而组建的队伍。 建议以框图的方式表示项目的组织结构，并对每一组织的负责人和职责加以说明。 可能的项目组织单元，如： （ 1）项目管理组 （ 2）质量保证组 （ 3）配置管理组 （ 4）软件工程组 （ 5）测试组 （ 6）需求管理组 各组织说明如下： （ 1）项目管理组，执行 SPP 和 SPTO 过程，对项 目实施负全部责任。 （ 2）质量保证组，执行 SQA 过程，负责项目过程与产品的质量控制和报告。 （ 3）配置管理组，执行 SCM 过程，负责项目产品的版本、配置管理以及配置库状态报告。 （ 4）软件工程组，执行软件项目工程过程，负责项目产品的开发和维护工作。 （ 5）测试组，执行软件项目测试过程，负责项目产品的测试。 （ 6）需求管理组，负责对需求基线和需求变更进行管理。 4．软件生存周期 （ Software Life Cycle） 本章节记录项目策划生存期定义的工作结果，需要描述的主要内容： （ 1）项目生存期框图 （ 2）项 目生存期说明 5．规范、方法和标准 （ Criterion， Means， Standard） 本章节中需要描述采用的供开发和维护软件用的规范、方法和标准。 6．任务与工作产品 （ Task and Work Products） 项目任务和工作产品，是指根据项目生存期阶段划分的任务，和相应阶段的工作产品。 记录项目生存期各阶段确定的需重点控制的阶段任务和工作产品。 建议以表格的形式，列出生存期各阶段的任务和工作产品。 项目包含的任务，如： （ 1）需求分析 （ 2）系统设计 （ 3）系统实现 （ 4）测试 （ 5）产品交付 （ 6）产品 维护 项目可能包含的产品，如： （ 1）需求分析说明书 （ 2）规格分析说明书 （ 3）系统设计说明书 （ 4）源代码 （ 5）各种测试报告 （ 6）用户手册 （ 7）软件问题维护记录 7．工作产品、任务规模、工作量 估计 （ Estimates of Work Product， Task Size and Workload） 项目规模估算是为了确定项目所需的人工。 需要描述的主要内容有： （ 1）对软件工作产品规模估计依据的简要描述。 （ 2）每种任务和工作产品规模估计的结果。 （ 3）规模估算的结果，建议用《任务规模和工作量估算表》 的形式列出。 8．成本估计 （ Estimates of Costs） 成本估计，是指对项目完成过程中耗费的人力、物力、财力资源的估算。 成本估计应按类别进行估算，可能的成本估算类别，如： （ 1）直接人工 （ 2）直接费用 （ 3）间接成本 （ 4）制造费用 （ 5）管理费用 （ 6）不可预见费用 9．关键计算机资源计划 （ Critical Computer Resource Plan） 项目的关键计算机资源计划，是指系统在开发环境、测试环境、及用户目标环境中，对关键计算机资源，如计算机存储能力、计算机处理器速度、通信通道容 量、服务器处理能力等的估计，使之能满足软件开发、测试、运行的要求。 10．软件项目进度计划 （ Software Project Schedule） 件项目进度计划，是对项目的进度、人员工作分工所做的计划，此计划依据上述各章的估算和分析结果，计划方式建议采用表格的形式。 若采用工具制定项目计划，应将工具生成的图表作为项目计划的附件。 本章节中需要描述的主要内容有： （ 1）软件项目每个阶段的进度时间表 （ 2）设定的里程碑 （ 3）评审时间 （ 4）缓冲时间 11．配置管理计划（可单独做一个计划） （ Configuration Management Planning） 本书单独作为一章论述。 12．质量保证计划（可单独做一个计划） （ Software Quality Assurance Planning） 本书单独作为一章论述。 13．风险分析 （ Risks Analysis） 项目风险分析，是指对可能发生的将会对项目按预期时间、资源和预算完成产生重大影响的事件的分析包括： （ 1）被识别出的重大风险事件：政策风险、技术风险、技能风险等。 （ 2）易发生重大风险事件的高风险区域：用户需求、设计、测试、运行平台等。 （ 3）重大风险事件的 级别：功能不全、性能不稳、迅速受限制等。 （ 4）拟采取的预防措施：增加投入、纠错、延时等。 （ 5）风险事件发生后建议采用的处理措施：更改计划、降低难度系数等。 14．设备工具计划 （ Equipment and Tools Planning） 项目设备工具计划，是根据项目的工作指派及进度确定项目所需要的设备和工具，以确保设备工具在任务执行前到位，保证项目任务的顺利执行，在本计划中应包含以下几方面的内容： （ 1）所需的设备 （ 2）基本的要求 （ 3）应到位的时间 15．培训计划 （ Training Planning） 项目的培训计划，应根据项目的特点和项目组成员技能情况，制定出项目组成员所需的培训内容，培训计划中应包含以下几方面： （ 1）培训内容 （ 2）培训时间 （ 3）教员 （ 4）接受培训的人员 （ 5）培训目的（应达到的效果） 16．项目评审 （ Project Reviews） 项目评审，是对项目策划过程所做的定期性评审。 其内容可分为： （ 1）评审点 （ 2）评审周期 （ 3）评审层次 （ 4）评审条款和措施 （ 5）管理评审活动中提交的工作产品（列出被评审的工作产品） 17．度量 （ Measurement） 度量是按规定在项目进 行过程中，需要采集的度量数据，以便量化地反映项目的进展情况，为管理者提供对项目进展的适当的可视性，同时度量数据是项目过程改善的数据基础。 应规定项目度量值的记录人（一般为项目经理或其指定人员）、记录时间（一般以定期评审为基础）和记录的数据。 常用的度量数据如： （ 1）项目过程的评审次数 （ 2）项目计划修改次数 （ 3）项目各阶段的人员投入（各阶段投入的人月数） （ 4）各类任务耗用时间统计（如设计、编码、测试、文档编写等） （ 5）工作产品统计（如文档字数、功能点数、用况数、源代码行数等） 5《用户需求报告》 《用 户需求报告》编写参考指南 1．概述 （ Summary） 本文档是进行需求规格定义、项目策划、概要设计的基础，也是用户进行验收的依据。 用户简介（ User Synopsis） 在本章节中要将用户的基本情况描述清楚，以便于分析人员划定系统范围，进行关于功能、进度、成本、性能等方面的平衡决策。 对于产品开发类项目，需要在此将该产品定义的用户群的特点描述清楚。 项目的目的与目标（ Purpose and Aim of Project） 项目的目的是对开发本系统意图的总概括。 项目的目标是将目的细化后的具体 描述。 项目目标应是明确的、可度量的、可以达到的 , 项目的范围应能确保项目的目标可以达到。 对于项目的目标可以逐步细化，以便与系统的需求建立对应关系，检查系统的功能是否覆盖了系统目标。 术语定义（ Terms Glossary） 将该用户需求报告中的术语、缩写进行定义 , 包括用户应用领域与计算机领域的术语与缩写等。 参考资料（ References） 说明该用户需求报告使用的参考资料，如： [1] 商务合同 [2] 招标书 [3] 用户领域的资料 [4] 用户需求调查表 [5] 参照的标准 每一个 文件、文献要有标题、或文件号，发布或发表日期以及出版单位。 相关文档（ Related Documents） 说明用户需求报告的变更，以及可能受变更影响的其他相关文档，如： [1] 项目开发计划 [2] 需求规格说明书 版本更新信息（ Version Updated Record） 版本更新记录格式，如表 511 所示。 表 511 版本更新记录 版本号 创建者 创建日期 维护者 维护日期 维护纪要 王大林 2001/02/18 — — — — — 王小林 2001/02/26 账本格式维护 2．现有系统描述 （ System in Existence） 组织结构与职责（ Organizing Framework and Function） 将用户的组织结构逐层详细描述，建议采用树状的组织结构图进行表达，每个部门的职责也应进行简单的描述。 组织结构是用户企业业务流程与信息的载体，对分析人员理解企业的业务、确定系统范围很有帮助。 取得用户的组织结构，是需求获取步骤中的工作任务之一。 岗位定义（ Role Definition） 用户环境 中的企业岗位和组织结构一样，也是分析人员理解企业业务的基础，是需求获取的工作任务，同时也是分析人员提取对象的基础。 每个岗位的职责可以进行详细的描述，建议采用表格的形式，如表 512所示。 表 512 岗 位 定 义 编 号 岗 位 所在部门 职 责 相关的业务 1008 采购员 业务部 商品采购、合同签订、供应商选择 进货、合同管理 1009 „„ 对用户岗位的识别，也包括使用了计算机系统后的系统管理人员岗位。 作业流程（ Busywork Flow） 企业的作业 流程，首先要有一个总的业务流程图，将企业中各种业务之间的关系描述出来，然后对每种业务进行详细的描述，使业务流程与部门职责结合起来。 详细业务流程图可以采用直式业务流程图、 Use case图、程序流程图加上文字说明。 图形可以将流程描述得很清楚，但是还要附加一些文字说明，如关于业务发生的频率、意外事故的处理、高峰期的业务频率等，不能在流程图中描述的内容，需要用文字进行详细描述。 单据、账本、报表（ Bill of Document， Account and Report） 现行系统中用户正在使用的正式的或非 正式的单据、账本、报表等可以收集起来，并进行穷举、分类、归纳。 单据、账本、报表是用户系统中信息的载体，是进行系统需求分析的基础，无论采用哪种分析方法，这都是必不可少的信息源。 单据（ Bill of Document） 单据的格式可用表格描述，如表 513 所示。 表 513 单据的描述格式 单据名称 用途 使用单位 制作单位 频率 高峰时数据流量 各数据项的详细说明如下： 序号 数据项中文名 数据项英文名 类型、长度、精度 数据项的取值范围 1 2 3 账本（ Account） 因为账本上的数据是统计数据，所以一个账本一般对应一张中间表，账本的格式可用表格描述，如表 514所示。 表 514 账本的描述格式 账本名称 用途 使用单位 制作单位 频率 高峰时数据流量 各数据项的详细说明如下： 序号 数据项中文名 数据项英文名 数据项类型、长度、精度 数据来源 1 2 3 报表（ Report） 因为报表上的数据是统计数据，所以一个报表一般对应一张中间表，报表的格式 可用表格描述，如表 515所示。 存在的问题（ Existent Question） 在现行的系统中，决策层、管理层、操作层各存在哪些方面的问题需要计算机来解决，尤其是决策层、管理层这些问题中包含了用户的需求与期望，有些问题是新系统可以解决的，有些问题则不是。 表 515 报表的描述格式 报表名称 用途 使用单位 制作单位 频率 高峰时数据流量 各数据项的详细说明如下： 序号 数据项中文名 数据项英文名 数据项类型、长度、精度 数据来源 1 2 3 可能的变化（ Possible Change） 对于现行的系统，将来可能会有哪些变化，需要在此描述。 企业中的变化是永恒的，系统分析员需要描述哪些变化可能引起系统范围变更。 3．目标系统功能需求 （ Function of Target System） 功能需求分析（ Function Analysis） 决策层、管理层、操作层各有哪些具体功能要求。 功能需求点列表（ Functi。