软件文档管理指南(可编辑修改版).
- 格式：pdf
- 大小：136.30 KB
- 文档页数：6
下载文档原格式
合集下载
软件配置管理过程指导说明书(超级实用)
软件配置管理过程指导说明书目录1 前言 (2)1.1 目的 (2)1.2 适用范围 (2)1.3 术语名词解释 (2)2 角色和职责说明 (3)3 输入 (4)4 入口准则 (4)5 配置管理实施 (4)5.1 配置库结构 (4)5.1.1 配置库 (4)5.1.2 配置管理库系统 (6)5.2 配置管理流程 (6)5.2.1 配置管理流程图 (6)5.2.2 配置变更流程图 (7)5.3 配置标识 (8)5.3.1 配置库划分 (8)5.3.2 配置库结构 (8)5.3.3 配置项命名 (11)5.3.4 版本编号规范 (11)5.4 配置管理活动 (12)5.4.1 制定配置管理计划 (12)5.4.2 建立配置库 (12)5.4.3 建立配置项 (12)5.4.4 基线建立及发布过程 (12)5.4.5 配置变更 (13)5.4.6 配置审计 (15)5.4.7 备份 (16)6 输出 (16)7 出口准则 (16)8 本过程裁剪规定 (16)1 前言1.1 目的用于描述配置管理作用和过程，规范配置管理的实施过程、活动和操作。
1.2 适用范围适用于在软件生命周期中对各类软件项目的配置管理活动。
1.3 术语名词解释CCB：Configuration Control Board，配置管理委员会，每个项目组需要建立项目级的CCB作为变更控制权威。
CCB由质量工程师、项目经理、测试经理、配置管理员构成，有时也可以包括客户代表、上级质量部门主管。
CCB组长可以是质量工程师或质量部领导，但不能是项目经理。
软件配置项：是指软件工程过程中所生产或使用的任何元素，或者是纳入软件产品的元素。
它可以是说明书、计算机程序、数据结构或者开发软件产品所使用的工具等，包括：项目文档，源代码，执行程序，相关设备及资料。
软件配置管理：对软件配置项的管理称为软件配置管理。
软件配置管理的目的是建立和维护软件项目整个生命周期中工作产品的完整性和可追溯性。
软件项目管理系统操作手册
软件项目管理系统操作手册第1章系统概述与安装 (3)1.1 系统简介 (3)1.2 系统安装与配置 (4)1.2.1 系统环境要求 (4)1.2.2 安装步骤 (4)1.2.3 配置说明 (4)1.3 系统启动与登录 (4)1.3.1 启动系统 (4)1.3.2 登录系统 (4)第2章用户界面与基本操作 (5)2.1 用户界面布局 (5)2.1.1 主界面 (5)2.1.2 弹出窗口 (5)2.2 常用操作指南 (5)2.2.1 打开与关闭模块 (5)2.2.2 浏览与搜索 (5)2.2.3 新增、修改与删除 (5)2.3 菜单与工具栏功能介绍 (5)2.3.1 菜单栏 (6)2.3.2 工具栏 (6)第3章项目创建与管理 (6)3.1 创建新项目 (6)3.1.1 登录系统 (6)3.1.2 进入项目创建页面 (6)3.1.3 填写项目基本信息 (7)3.1.4 提交项目创建申请 (7)3.2 项目基本信息设置 (7)3.2.1 项目概述 (7)3.2.2 项目里程碑 (7)3.2.3 项目预算 (7)3.2.4 项目优先级 (7)3.3 项目成员与角色分配 (7)3.3.1 添加项目成员 (7)3.3.2 设置角色权限 (7)3.3.3 成员职责分配 (7)3.4 项目进度跟踪与调整 (7)3.4.1 任务分解 (7)3.4.2 进度监控 (7)3.4.3 进度调整 (8)3.4.4 项目报告 (8)第4章任务管理 (8)4.1.1 创建任务 (8)4.1.2 编辑任务 (8)4.2 任务分配与优先级设置 (9)4.2.1 任务分配 (9)4.2.2 优先级设置 (9)4.3 任务进度更新与状态跟踪 (9)4.3.1 任务进度更新 (9)4.3.2 任务状态跟踪 (9)第5章文档管理 (10)5.1 文档分类与创建 (10)5.1.1 文档分类 (10)5.1.2 文档创建 (10)5.2 文档编辑与共享 (10)5.2.1 文档编辑 (10)5.2.2 文档共享 (10)5.3 文档权限控制与版本管理 (11)5.3.1 文档权限控制 (11)5.3.2 版本管理 (11)第6章风险管理 (11)6.1 风险识别与评估 (11)6.1.1 风险识别 (11)6.1.2 风险评估 (12)6.2 风险应对策略制定 (12)6.2.1 风险应对策略类型 (12)6.2.2 风险应对策略制定步骤 (12)6.3 风险监控与报告 (12)6.3.1 风险监控 (12)6.3.2 风险报告 (13)第7章质量管理 (13)7.1 质量计划制定 (13)7.1.1 目的 (13)7.1.2 操作步骤 (13)7.2 质量检查与评审 (13)7.2.1 目的 (13)7.2.2 操作步骤 (13)7.3 质量问题跟踪与改进 (14)7.3.1 目的 (14)7.3.2 操作步骤 (14)第8章团队协作与沟通 (14)8.1 团队成员协作 (14)8.1.1 成员角色与权限 (14)8.1.2 任务分配与跟进 (14)8.1.3 团队协作文件 (14)8.2.1 系统通知 (15)8.2.2 邮件通知 (15)8.2.3 短信提醒 (15)8.3 项目讨论与留言 (15)8.3.1 项目讨论区 (15)8.3.2 任务留言 (15)8.3.3 私信功能 (15)第9章报表与数据分析 (15)9.1 报表类型与 (15)9.1.1 报表类型 (15)9.1.2 报表 (16)9.2 数据分析工具介绍 (16)9.2.1 数据透视表 (16)9.2.2 图表分析 (16)9.2.3 数据挖掘 (16)9.3 自定义报表与导出 (16)9.3.1 自定义报表 (16)9.3.2 导出报表 (16)第10章系统设置与维护 (17)10.1 系统参数设置 (17)10.1.1 访问系统参数设置 (17)10.1.2 参数配置 (17)10.1.3 保存与生效 (17)10.2 用户管理 (17)10.2.1 添加用户 (17)10.2.2 修改用户信息 (17)10.2.3 删除用户 (17)10.3 权限与角色配置 (17)10.3.1 角色管理 (18)10.3.2 权限配置 (18)10.3.3 用户角色分配 (18)10.4 系统备份与恢复 (18)10.4.1 系统备份 (18)10.4.2 系统恢复 (18)第1章系统概述与安装1.1 系统简介软件项目管理系统是为了提高项目团队的工作效率，优化项目管理流程，保证项目按时按质完成而设计的一套全面、高效的管理工具。
软件配置管理指南
软件配置管理指南编号：PRO-SCMP版本 1.0变更记录1引言软件配置管理的目的是在项目整个软件生存周期过程中建立和维护软件项目产品的完整性和一致性。
软件配置管理包括确认在给定时间点上软件的配置（即选定的软件工作产品及其描述），系统地控制对配置的更改，并维护在整个软件生存周期中配置的完整性和可跟踪性。
置于软件配置管理之下的工作产品包括：软件过程资产（例如软件过程改进中的所有文档），交付给顾客的软件产品（例如软件需求文档和代码），内部使用的相关软件产品，以及为完成这些软件产品而生成的中间产品。
这些产品通常置于产品基线库中并由专门人员进行管理和控制。
软件配置管理过程需要达到的目标包括：1.保证软件项目的配置管理活动是有计划的。
2.所选择的软件工作产品是确定的、受控的、可访问和可用的。
3.对已经确定的软件工作产品的变更是受控的。
4.相关部门和人员能及时获知软件基线库的状态、变更和变更内容。
1.1目的本计划定义了项目的配置管理流程，目的是为了在整个软件生命周期中，控制构成软件产品的各配置项的标识、变更等活动，从而建立并维护软件产品的完整性、正确性、一致性和可追溯性。
1.2范围本软件配置管理计划适用于整个软件生存周期过程中已纳入配置管理库的配置项的活动。
置于配置管理系统下的工作产品通常包括：1.各种标准（代码书写标准、设计标准等）2.项目计划（开发计划、质量保证计划和配置管理计划等）3.软件需求说明书及相关的文档和静态原型4.设计文档5.软件源代码6.测试计划、测试程序和数据7.软件操作手册8.各种跟踪记录、测试记录、评审报告等9.过程改进文档10.其它相关的资料库（电子的和非电子的文档）11.其他和软件开发及管理相关的和必要的文档1.3术语定义1.软件配置项（SCI）软件配置项（Software Configuration Item）为了配置管理的目的而作为一个基本的独立单位来看待的软件成分或它们的集合体，如外部提交的软件产品、项目成果(代码、文档和数据)以及项目内部使用的支持工具(如文档测试用例软件工具)等。
软件过程管理指南(Word最新版)
软件过程管理指南通过整理的软件过程管理指南相关文档，渴望对大家有所扶植，感谢观看！软件过程管理指南Software Process Manage Guide 文档标识：上海易宝软件有限公司深圳分公司修订记录版本说明作者批准批准日期V1.0 第一次发布曾奋瑞Marco 2007-03-01 目录软件过程管理指南1 1 序言8 1.1 简介8 1.2 目标8 1.3 适用范围8 1.4 术语8 2 文件清单9 2.1 软件项目策划PP 9 2.2 软件项目跟踪与监督PTO 9 2.3 需求管理RM 10 2.4 软件生命周期LC 10 2.5 软件质量保证SQA 12 3 项目过程12 4 组间协作15 5 关键实践集15 5.1 项目打算16 5.2 软件估计16 5.3 启动会议16 5.4 迭代开发17 5.5 设计界面雏形与用例说明17 5.6 特征跟踪19 5.7 设计领域模型19 5.8 具体设计19 5.9 运用项目工作管理系统20 5.10 里程碑会议21 5.11 风险清单22 5.12 技术评审22 5.13 建立配置库24 5.14 变更限制25 5.15 组件重用26 5.16 持续集成27 5.17 单元测试27 5.18 启动测试流程28 5.19 缺陷管理28 5.20 系统发布31 5.21 实施管理32 5.21.1 实施型项目月支配32 5.21.2 实施型项目月报33 5.21.3 系统发布说明33 5.22 产品与项目管理33 5.23 客户问题管理34 5.24 软件质量保证34 6 图表索引37 7 引用的过程及规程文件列表37 1 序言 1.1 简介上海易宝软件有限公司深圳分公司的各级管理人员和各个开发组都相识到，只有通过不断的过程改进才能使我们人员的实力和先进的技术得到充分的发挥。
因此，公司确定接受软件实力成熟度模型（CMMI3 ）这一标准来提高软件组织的工作效率、产品质量和项目的可预见性。
档案管理系统用户操作手册doc
档案管理系统用户操作手册doc一、概述本操作手册旨在为档案管理系统的用户提供使用说明和指导，以确保用户能够正确地使用系统进行档案管理工作。
本手册将涵盖系统的基本功能、使用方法、常见问题及解决方案，以及安全和隐私方面的注意事项。
二、系统简介档案管理系统是一款专门设计的软件，用于帮助用户高效地管理、存储、检索和共享档案信息。
系统支持多种档案类型，包括文档、图片、视频等，并提供了强大的搜索功能，方便用户快速查找所需档案。
系统还具备安全和隐私保护功能，确保用户数据的安全性。
三、安装与登录1、下载与安装：请从官方网站或授权渠道下载本系统的安装包，按照提示进行安装。
请确保您的计算机满足系统要求。
2、登录：打开系统后，输入您在注册时所使用的用户名和密码，点击“登录”按钮即可。
如果您忘记了密码，可以通过找回密码的方式找回。
四、功能介绍1、添加档案：点击左侧的“添加档案”按钮，选择档案类型，填写档案标题、描述等信息，上传所需文件，点击“保存”按钮即可。
2、搜索档案：在搜索框中输入关键词或短语，点击“搜索”按钮，系统将显示匹配的档案列表。
您还可以通过筛选条件对结果进行进一步筛选。
3、编辑档案：在档案列表中选中所需编辑的档案，点击“编辑”按钮，对档案信息进行修改。
修改完成后，点击“保存”按钮即可。
4、删除档案：在档案列表中选中所需删除的档案，点击“删除”按钮，系统将提示您是否确认删除操作。
确认后，档案将被永久删除。
5、导出档案：点击左侧的“导出”按钮，选择导出的文件类型和格式，系统将生成包含所选档案的导出文件。
您可以将导出文件保存到本地或共享给其他用户。
五、常见问题及解决方案1、问题：无法登录系统怎么办？解决方案：请检查您的用户名和密码是否正确。
如果密码忘记或被锁定，可以通过找回密码或管理员的方式解决。
2、问题：无法添加或编辑档案怎么办？解决方案：请确认您是否具有足够的权限执行该操作。
如果您是管理员，可以检查系统设置中的权限设置；如果您是普通用户，请管理员赋予您相应的权限。
系统集成项目管理工程师试题库含参考答案
系统集成项目管理工程师试题库含参考答案1、根据《软件文档管理指南》(GB/T16680-1996)，以下关于软件文档归类的叙述，（）是不正确的。
A、开发文档描述开发过程本身B、产品文档描述开发过程的产物C、管理文档记录项目管理的信息D、过程文档描述项目实施的信息答案：D2、某软件开发项目的《概要设计说明书》版本号V2.13，该配置项的状态是（）A、首次发布B、正在修改C、正式发布D、草稿答案：B3、关于项目的风险管理，下列说法中，（）是不正确的。
A、风险管理包括风险识别、定性分析、定量分析、风险应对、风险监控等过程B、定性风险分析后，可制定和采取风险应对措施C、制定了风险应对措施后，可重新进行定量风险分析，以确定风险降低的程度D、风险管理的最终目标是消除风险答案：D4、螺旋模型沿着螺线进行若干次迭代，每次迭代中的活动依次为（）。
A、需求分析、风险分析、实施工程和客户评估B、需求收集、制定计划、风险分析和实施工程C、制定计划、风险分析、实施工程和软件运维D、制定计划、风险分析、实施工程和客户评估答案：D5、整体变更控制过程实际上是对（）的变更进行标识、文档化、批准或拒绝，并控制的过程。
A、详细的WBS计划B、项目基准C、项目预算D、明确的项目组织结构答案：B6、某项采购已经到了合同收尾阶段，为了总结这次采购过程中的经验教训，以供公司内的其他项目参考借鉴，公司应组织（）。
A、业绩报告B、采购评估C、项目审查D、采购审计答案：D7、软件统一过程(RUP)是迭代模型的一种。
以下关于RUP的叙述中，不正确的是（）A、RUP生命周期在时间上分为4个顺序阶段，分别是：初始阶段，细化阶段，构建阶段和交付阶段B、RUP的每个阶段里面都要执行核心过程工作流的“商业建模”，“需求”，“分析和设计”，“实现”，“测试”，"部署“。
每个阶段的内部完成一次迭代即可。
C、软件产品交付给用户使用一段时间后如有新的需求则应该开始另外一个RUP开发周期D、RUP可以用于大型复杂软件项目开发答案：B8、在进行项目整体变更控制中，首先要受理变更申请，接下来（）A、接受或拒绝变更B、执行变更C、进行变更结果追踪与审核D、进行变更的整体影响分析答案：D9、根据我国“十三五”规划纲要，（）不属于新一代信息技术产业创新发展的重点。
2023年高级软考《信息系统项目管理师》考试历年真题摘选附带答案
2023年高级软考《信息系统项目管理师》考试历年真题摘选附带答案第1卷一.全考点综合测验(共20题)1.【单选题】某公司中标一个企业信息化系统开发项目，合同中该项目包括：人事系统、OA系统和生产系统。
下图为项目经理制作的WBS，此处项目经理违反了关于WBS的()原则。
A.WBS需要考虑将不同的人员的工作分开B.WBS中各项工作是为提供可交付成果服务的C.可以按照系统子系统来逐层分解WBSD.一个工作单元只能从属于某个上层单元2.【单选题】() 不属于管理文档A.变更控制记录B.开发计划C.项目总结报告D.需求文件评审记录3.【单选题】2015 年国务院发布的《关于积极推进“互联网+”行为的指导意见》提出：到()年，网络化、智能化、服务化、协同化的“互联网+”产业生态体系基本完善，“互联网+”称为经济社会创新发展的重要驱动力量。
A.2018B.2020C.2025D.20304.【单选题】以下网络安全防御技术中，()是一种较早使用、实用性很强的技术，它通过逻辑隔离外部网络与受保护的内部网络的方式，使用本地系统免于受到威胁。
A.防火墙技术B.入侵检测与防护技术C.VPN 技术D.网络蜜罐技术5.【单选题】()不属于项目经理的岗位职责A.为严格控制项目成本，可不全面执行所在单位的技术规范标准B.对项目的全生命周期进行有效控制，确保项目质量和工期C.在工作中主动采用项目管理理念和方法D.以合作和职业化方式与团队和项目干系人打交道6.【单选题】项目经理张工带领团队编制项目管理计划，()不属于编制项目管理计划过程的依据。
A.项目章程B.事业环境因素C.组织过程资产D.工作分解结构7.【单选题】产品分析属于哪个过程的工具A.范围规划B.范围定义C.范围核实D.范围控制8.【单选题】以下关于大型复杂项目和多项目管理的叙述中，不正确的是()。
A.大型复杂项目必须建立以过程为基础的管理体系B.为了确保大型复杂项目的过程制度起到预期作用，必须在项目团队内部建立统一的体系，包括制定过程、计划过程、执行过程C.大型复杂项目的项目过程确定后，再制定项目计划D.大型IT 项目大都是在需求不十分清晰的情况下开始的，所以项目自然分成需求定义和需求实现两个主要阶段9.【单选题】某集成企业的软件著作权登记发表日期为20XX年9 月30 日, 按照著作权法规定,其权利保护期到()A.2063年12 月31 日B.2063年9月29 日C.2033年12 月31 日D.2033年9月29 日10.【单选题】项目整体绩效评估中风险评估是一个十分重要的技术。
2023年中级软考《系统集成项目管理工程师》考试全真模拟易错、难点精编⑴(答案参考)试卷号：8
2023年中级软考《系统集成项目管理工程师》考试全真模拟易错、难点精编⑴（答案参考）（图片大小可自由调整）一.全考点综合测验(共50题)1.【单选题】基于TCP/IP 协议的网络属于信息传输模型中的( )。
A.信源B.信道C.信宿D.编解码正确答案：B2.【单选题】以下关于文档管理的描述中，( )是正确的。
A.程序源代码清单不属于文档B.文档按项目周期角度可以分为开发文档和管理文档两大类C.文档按重要性和质量要求可以分为正式文档和非正式文档D.《软件文档管理指南》明确了软件项目文档的具体分类正确答案：C解析该题的选项为“ C.文档按重要性和质量要求可以分为正式文档和非正式文档”。
3.【单选题】根据下面的UML 类图，以下叙述中()是不正确的。
A.容器是一个组件B.GUI 组件是一个对象C.GUI 组件是一个对象D.容器和GUI 组件都是组件正确答案：B4.【单选题】( )属于互联网在制造领域的应用范畴。
A.建设智能化工厂和数字化车间B.加强智能制造工控系统信息安全保障体系C.开展工业领域的远程诊断管理、全产业链追溯等正确答案：C5.【单选题】相对于来说，具有多种优势，()不属于的优势。
A.页面简洁、风格流畅B.个性化、突出自我品牌C.用户参与度高D.更加追求功能性利益正确答案：D6.【单选题】针对新中标的某政务工程项目，系统集成商在进行项目内部立项时，立项内容一般不包括( )。
A.项目资源分配B.任命项目经理C.项目可行性研究D.准备项目任务书正确答案：C7.【单选题】软件开发项目规模度量(sizemeasurement)是估算软件项目工作量、编制成本预算、策划合理项目进度的基础。
在下列方法中，()可用于软件的规模估算，帮助软件开发团队把握开发时间、费用分布等。
A.德尔菲法B.V 模型方法C.原型法D.用例设计正确答案：A8.【单选题】()是为了修正不一致的产品或产品组件而进行的有目的的活动。
A.纠正措施B.预防措施C.缺陷补救D.产品更新正确答案：C9.的企业，需要已建立完备的企业质量管理体系，通过国家认可的第三方认证机构认证并有效运行一年以上”。
软件使用手册范文(3篇)
第1篇第一章：概述1.1 软件简介XX办公自动化系统是一款集成了文档管理、邮件处理、日程安排、会议管理、项目管理等功能于一体的综合性办公软件。
它旨在提高工作效率，简化办公流程，为用户提供便捷、高效的办公体验。
1.2 系统功能1. 文档管理：支持文档的上传、下载、编辑、分享等功能。
2. 邮件处理：提供邮件收发、邮件分类、邮件搜索等功能。
3. 日程安排：支持日程的添加、修改、删除、提醒等功能。
4. 会议管理：支持会议的创建、修改、删除、参会人员管理等功能。
5. 项目管理：支持项目的创建、分配、进度跟踪、任务管理等功能。
1.3 系统环境1. 操作系统：Windows 7/8/10、Mac OS X 10.10及以上版本2. 处理器：Intel Core i3及以上3. 内存：4GB及以上4. 硬盘：100GB及以上5. 网络环境：宽带网络第二章：安装与启动2.1 安装步骤1. 下载软件安装包：请访问官方网站或授权渠道下载最新版本的XX办公自动化系统安装包。
2. 双击安装包，进入安装向导。
3. 阅读许可协议，勾选“我同意”后点击“下一步”。
4. 选择安装路径，点击“下一步”。
5. 等待安装完成，点击“完成”。
2.2 启动软件1. 在桌面找到XX办公自动化系统的快捷方式，双击打开。
2. 输入用户名和密码，点击“登录”。
第三章：功能模块使用指南3.1 文档管理1. 上传文档：点击“文档”菜单，选择“上传文档”，选择需要上传的文件，点击“上传”。
2. 下载文档：点击文档列表中的文件名，点击“下载”。
3. 编辑文档：双击文档列表中的文件名，打开文档进行编辑。
4. 分享文档：选中文档，点击“分享”，输入分享对象和权限，点击“分享”。
3.2 邮件处理1. 收发邮件：点击“邮件”菜单，进入邮件收发界面。
2. 邮件分类：点击“邮件”菜单，选择“邮件分类”，创建或编辑分类。
3. 邮件搜索：在邮件收发界面，输入搜索关键词，点击“搜索”。
软件文档管理指南.
· 要求哪些类型的文档 · 提供多少种文档 · 文档包含的内容 · 达到何种级别的质量水平 · 何时产生何种文档 · 如何保存、维护文档以及如何进行通信
· 如果一个软件合同是有效的，应要求文档满足所接 受的标准，并规定所提供的文档类型、每种文档的 质量水平以及评审和通过的规程。
15
主要内容
• 软件文档的作用 • 管理者的作用 • 制订文档编制策略 • 制订文档编制标准和指南 • 文档编制计划 • 制订文档规程 • 所需资源
19
支持有效文档策略的基本条件
· 文档标准应被标识和使用
➢应尽可能地采纳现行的标准，若没有合适的现行 标准，必要时应研制适用的标准或指南。
· 应规定支持工具
➢工具有助于开发和维护软件产品，包括文档。因 此尽可能地使用工具是经济的、可行的。
20
主要内容
• 软件文档的作用 • 管理者的作用 • 制订文档编制策略 • 制订文档编制标准和指南 • 文档编制计划 • 制订文档规程 • 所需资源
➢ 开发过程每个阶段的进度和进度变更的记录 ➢ 软件变更情况的记录 ➢ 相对于开发的判定记录 ➢ 职责定义
· 从管理的角度规定涉及软件生存的信息
31
相关知识
· 软件文档分类 · 软件文档与使用者的关系 · 软件生存周期各阶段与各种文档编制的关系 · 文档所回答的问题
32
3. 文档的质量等级
· 仅仅依据规章、传统的做法或合同的要求去 制作文档是不够的。管理者还必须确定文档 的质量要求以及如何达到和保证质量要求。
· 把文档计划作为整个开发工作的一个组成部分 · 建立确定文档质量、测试质量和评审质量各种方法
的规程
· 为文档的各个方面确定和准备各种标准和指南 · 积极支持文档工作以形成开发中自觉编制文档的团
· 如果一个软件合同是有效的，应要求文档满足所接 受的标准，并规定所提供的文档类型、每种文档的 质量水平以及评审和通过的规程。
15
主要内容
• 软件文档的作用 • 管理者的作用 • 制订文档编制策略 • 制订文档编制标准和指南 • 文档编制计划 • 制订文档规程 • 所需资源
19
支持有效文档策略的基本条件
· 文档标准应被标识和使用
➢应尽可能地采纳现行的标准，若没有合适的现行 标准，必要时应研制适用的标准或指南。
· 应规定支持工具
➢工具有助于开发和维护软件产品，包括文档。因 此尽可能地使用工具是经济的、可行的。
20
主要内容
• 软件文档的作用 • 管理者的作用 • 制订文档编制策略 • 制订文档编制标准和指南 • 文档编制计划 • 制订文档规程 • 所需资源
➢ 开发过程每个阶段的进度和进度变更的记录 ➢ 软件变更情况的记录 ➢ 相对于开发的判定记录 ➢ 职责定义
· 从管理的角度规定涉及软件生存的信息
31
相关知识
· 软件文档分类 · 软件文档与使用者的关系 · 软件生存周期各阶段与各种文档编制的关系 · 文档所回答的问题
32
3. 文档的质量等级
· 仅仅依据规章、传统的做法或合同的要求去 制作文档是不够的。管理者还必须确定文档 的质量要求以及如何达到和保证质量要求。
· 把文档计划作为整个开发工作的一个组成部分 · 建立确定文档质量、测试质量和评审质量各种方法
的规程
· 为文档的各个方面确定和准备各种标准和指南 · 积极支持文档工作以形成开发中自觉编制文档的团
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
软件文档管理指南范围本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。
本标准的目的在于协助管理者在他们的机构中产生有效的文档。
本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。
本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。
并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。
不论项目的大小，软件文档管理的原则是一致的。
对于小项目，可以不采用本标准中规定的有关细节。
管理者可剪裁这些内容以满足他们的特殊需要。
本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。
引用标准下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。
本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。
计算机软件开发规范计算机软件产品开发文件编制指南软件工程术语定义本标准采用下列定义，其他定义见。
文档一种数据媒体和其上所记录的数据。
它具有永久性并可以由人或机器阅读。
通常仅用于描述人工可读的内容。
例如，技术文件、设计文件、版本说明文件。
文档（集）；文档编制一个或多个相关文档的集合。
文档计划一个描述文档编制工作方法的管理用文档。
该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。
文档等级对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。
软件产品软件开发过程的结果，并推出供用户使用的软件实体。
软件文档的作用) 管理依据；) 任务之间联系的凭证；) 质量保证；) 培训与参考；) 软件维护支持；) 历史档案。
管理依据在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。
每一阶段计划安排的定期报告提供了项目的可见性。
定期报告还提醒各级管理者注意该部门对项目承担的责任以及该部门效率的重要性。
开发文档规定若干个检查点和进度表，使管理者可以评定项目的进度，如果开发文档有遗漏，不完善，或内容陈旧，则管理者将失去跟踪和控制项目的重要依据。
任务之间联系的凭证大多数软件开发项目通常被划分成若干个任务，并由不同的小组去完成。
学科方面的专家建立项目，分析员阐述系统需求，设计员为程序员制定总体设计，程序员编制详细的程序代码，质量保证专家和审查员评价整个系统性能和功能的完整性，负责维护的程序员改进各种操作或增强某些功能。
这些人员需要的互相联系是通过文档资料的复制、分发和引用而实现的，因而，任务之间的联系是文档的一个重要功能。
大多数系统开发方法为任务的联系规定了一些正式文档。
分析员向设计员提供正式需求规格说明，设计员向程序员提供正式设计规格说明，等等。
质量保证那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明；必须制订测试计划和测试规程，并报告测试结果；他们还必须说明和评估完全、控制、计算、检验例行程序及其他控制技术。
这些文档的提供可满足质量保证人员和审查人员上述工作的需要。
培训与参考软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他有关人员了解系统如何工作，以及为了达到他们的各自的目的，如何使用系统。
软件维护支持维护人员需要软件系统的详细说明以帮助他们熟悉系统，找出并修正错误，改进系统以适应用户需求的变化或适应系统环境的变化。
历史档案软件文档可用作未来项目的一种资源。
通常文档记载系统的开发历史，可使有关系统结构的基本思想为以后的项目利用。
系统开发人员通过审阅以前的系统以查明什么部分已实验过了，什么部分运行得很好，什么部分因某种原因难以运行而被排除。
良好的系统文档有助于把程序移植和转移到各种新的系统环境中。
管理者的作用管理者严格要求软件开发人员和编制组完成文档编制，并且在策略、标准、规程、资源分配和编制计划方面给予支持。
) 管理者对文档工作的责任。
管理者要认识到正式或非正式文档都是重要的，还要认识到文档工作必须包括文档计划、编写、修改、形成、分发和维护等各个方面。
) 管理者对文档工作的支持。
管理者应为编写文档的人员提供指导和实际鼓励，并使各种资源有效地用于文档开发。
) 管理者的主要职责：）建立编制、登记、出版系统文档和软件文档的各种策略；）把文档计划作为整个开发工作的一个组成部分；）建立确定文档质量、测试质量和评审质量的各种方法的规程；）为文档的各个方面确定和准备各种标准和指南；）积极支持文档工作以形成在开发工作中自觉编制文档的团队风气；）不断检查已建立起来的过程，以保证符合策略和各种规程并遵守有关标准和指南。
通常，项目管理者在项目开发前应决定如下事项：要求哪些类型的文档；提供多少种文档；文档包含的内容；达到何种级别的质量水平；何时产生何种文档；如何保存、维护文档以及如何进行通信。
如果一个软件合同是有效的，应要求文档满足所接受的标准，并规定所提供的文档类型、每种文档的质量水平以及评审和通过的规程。
制订文档编制策略文档策略是由上级（资深）管理者新任务并支持的，对下级开发单位或开发人员提供指导。
策略规定主要的方向不是做什么或如何做的详细说明。
一般说来，文档编制策略陈述要明确，并通告到每个人且理解它，进而使策略被他们贯彻实施。
支持有效文档策略的基本条件：) 文档需要覆盖整个软件生存期在项目早期几个阶段就要求有文档，而且在贯穿软件开发过程中必须是可用的和可维护的。
在开发完成后，文档应满足软件的使用、维护、增强、转换或传输。
) 文档应是可管理的指导和控制文档的获得维护，管理者和发行专家应准备文档产品、进度、可靠性、资源，质量保证和评审规程的详细计划大纲。
) 文档应适合于它的读者读者可能是管理者、分析员、无计算机经验的专业人员、维护人员、文书人员等。
根据任务的执行，他们要求不同的材料表示和不同的详细程度。
针对不同的读者，发行专家应负责设计不同类型的文档。
) 文档效应应贯穿到软件的整个开发过程中在软件开发的整个过程中，应充分体现文档的作用和限制，即文档应指导全部开发过程。
) 文档标准应被标识和使用应尽可能地采纳现行的标准，若没有合适的现行标准，必要时应研制适用的标准或指南。
) 应规定支持工具工具有助于开发和维护软件产品，包括文档。
因此尽可能地使用工具是经济的、可行的。
附录中的检查表为制定策略条款或评估现有策略条款的有效性和完整性提供帮助。
制订文档编制标准和指南在一个机构内部，应采用一些标准和指南：——软件生存期模型；——文档类型和相互关系；——文档质量。
这些标准和指南决定如何实现文档任务，将提供一些准则以评价机构内所产生的软件文档的完整性、可用性和适合性。
尽可能地采用现行的国家和国际标准，若现行的标准不适用，机构应制订自己的标准。
选择软件生存期模型现有的一些软件生存期模型，对于不同的阶段有不同的词汇，从软件文档的观点来看，采用哪种模型都无关紧要，只要阶段和相应的文档是清晰定义的、已计划的，并且对于任何具体软件项目是能遵循的。
因此，管理者应选择一个软件生存期模型并保证该模型在他们机构内是适用的。
管理者将会发现所进行的阶段和相应任务的定义有助于监控软件项目的进展。
相应于特定阶段生成的文档可用作该阶段的评审、通过和完成的检验点，而这种检验应在下一阶段开始前进行。
规定文档类型和内容下面给出软件文档主要类型的大纲，这个大纲不是详尽的或最后的，但适合作为主要类型软件文档的检验表。
而管理者应规定何时定义他们的标准文档类型。
软件文档归入如下三种类别：) 开发文档——描述开发过程本身；) 产品文档——描述开发过程的产物；) 管理文档——记录项目管理的信息。
开发文档开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述（程序逻辑、程序间相互关系、数据格式和存储等）。
开发文档起到如下五种作用：) 它们是软件开发过程中包含的所有阶段之间的通信工具，它们记录生成软件需求、设计、编码和测试的详细规定和说明；) 它们描述开发小组的职责。
通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做；) 它们用作检验点而允许管理者评定开发进度。
如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具；) 它们形成了维护人员所要求的基本的软件支持文档。
而这些支持文档可作为产品文档的一部分；) 它们记录软件开发的历史。
基本的开发文档是：——可行性研究和项目任务书；——需求规格说明；——功能规格说明；——设计规格说明，包括程序和数据规格说明；——开发计划；——软件集成和测试计划；——质量保证计划、标准、进度；安全和测试信息。
产品文档产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。
产品的文档起到如下三种作用：) 为使用和运行软件产品的任何人规定培训和参考信息；) 使得那些未参加开发本软件的程序员维护它；) 促进软件产品的市场流通或提高可接受性。
产品文档用于下列类型的读者：——用户——他们利用软件输入数据、检索信息和解决问题；——运行者——他们在计算机系统上运行软件；——维护人员——他们维护、增强或变更软件。
产品文档包括如下内容：——用于管理者的指南和资料，他们监督软件的使用；——宣传资料通告软件产品的可用性并详细说明它的功能、运行环境等；——一般信息对任何有兴趣的人描述软件产品。
基本的产品文档包括：——培训手册；——参考手册和用户指南；——软件支持手册；——产品手册和信息广告。
管理文档这种文档建立在项目管理信息的基础上，诸如：——开发过程的每个阶段的进度和进度变更的记录；——软件变更情况的记录；——相对于开发的判定记录；——职责定义。
这种文档从管理的角度规定涉及软件生存的信息。
相关文档的详细规定和编写格式见。
确定文档的质量等级仅仅依据规章、传统的做法或合同的要求去制作文档是不够的。
管理者还必须确定文档的质量要求以及如何达到和保证质量要求。
质量要求的确定取决于可得到的资源、项目的大小和风险，可以对该产品的每个文档的格式及详细程度作出明确的规定。
每个文档的质量必须在文档计划期间就有明确的规定。
文档的质量可以按文档的形式和列出的要坟划分为四级。
最低限度文档（级文档）级文档适合开发工作量低于一个人月的开发者自用程序。
该文档应包含程序清单、开发记录、测试数据和程序简介。
内部文档（级文档）级文档可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。
除级文档提供的信息外，级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。