文档介绍：软件管理指南
软件管理指南
1/12
软件管理指南
软件文档管理指南
1范围
本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准理指南
12/12
软件管理指南
软件文档的另一个功能是使系统管理员、操作员、用户、管理者和其他相关人员认识系统怎样工作，以及为了达到他们的各自的目的，怎样使用系统。
维护人员需要软件系统的详尽说明以帮助他们熟悉系统，找出并修正错误，改进系统以适应用户需求的变化或适应系统环境的变化。
软件文档可用作未来项目的一种资源。平时文档记录系统的开发历史，可使相关系统结构的基本思想为今后的项目利用。系统开发人员经过审阅以前的系统以查明什么部分已试验过了，什么部分运行得很好，什么部分因某种原因难以运行而被消除。优异的系统文档有助于把程序移植和转移到各种新的系统环境中。
管理者的作用
管理者严格要求软件开发人员和编制组完成文档编制，并且在策略、标准、规程、资源分配和编制计划方面恩赐支持。
管理者对文档工作的责任。管理者要认识到正式或非正式文档都是重要的，还要认识到文档工作必须包括文档计划、编写、更正、形成、散发和维护等各个方面。
管理者对文档工作的支持。管理者应为编写文档的人员提供指导和实际鼓励，并使各种资源有效地用于文档开发。
管理者的主要职责：
1）建立编制、登记、出版系统文档和软件文档的各种策略；
2）把文档计划作为整个开发工作的一个组成部分；
软件管理指南
软件管理指南
7/12
软件管理指南
3）建立确定文档质量、测试质量和评审质量的各种方法的规程；
软件管理指南
软件管理指南
12/12
软件管理指南
4）为文档的各个方面确定和准备各种标准和指南；
5）积极支持文档工作以形成在开发工作中自觉编制文档的团队风气；
6）不断检查已建立起来的过程，以保证吻合策略和各种规程并遵守相关标准和指南。
平时，项目管理者在项目开发前应决定如下事项：
要求哪些种类的文档；
提供多少种文档；
文档包含的内容；
达到何种级其他质量水平；
何时产生何种文档；
怎样保存、维护文档以及怎样进行通信。
如果一个软件合同是有效的，应要求文档知足所接受的标准，并规定所提供的文档种类、每种文档的质量水平以及评审和经过的规程。
制订文档编制策略
文档策略是由上级（资深）管理者新任务并支持的，对下级开发单位或开发人员提供指导。策略规定主要的方向不是做什么或怎样做的详尽说明。
一般说来，文档编制策略陈述要明确，并通知到每个人且理解它，进而使策略被他们贯彻实施。
支拥有效文档策略的基本条件：
软件管理指南
软件管理指南
9/12
软件管理指南
文档需要覆盖整个软件生存期
软件管理指南
软件管理指南
12/12
软件管理指南
在项目早期几个阶段就要求有文档，而且在贯穿软件开发过程中必须是可用的和可维护的。在开发完成后，文档应知足软件的使用、维护、增强、变换或传输。
文档应是可管理的
指导和控制文档的获得维护，管理者和刊行专家应准备文档产品、进度、可靠性、资源，质量保证和评审规程的详尽计划大纲。
文档应适合于它的读者
读者可能是管理者、解析员、无计算机经验的专业人员、维护人员、文书人员等。根据任务的执行，他们要求不同的材料表示和不同的详尽程度。针对不同的读者，刊行专家应负责设计不同种类的文档。
文档效应应贯穿到软件的整个开发过程中
在软件开发的整个过程中，应充分体现文档的作用和限制，即文档应指导全部开发过程。
文档标准应被表记和使用
应尽可能地采纳现行的标准，若没有合适的现行标准，必要时应研制适用的标准或指南。
应规定支持工具
工拥有助于开发和维护软件产品，包括文档。因此尽可能地使用工具是经济的、可行的。
附录A中的检查表为拟定策略条款或评估现有策略条款的有效性和完整性提供帮助。
软件管理指南
软件管理指南
11/12
软件管理指南