计算机软件文档编制细则.pptVIP

冯惠 ;目次;一、本标准修订的背景;二、GB/T8567-2006制定的依据;三、ＧＢ／Ｔ８５６７新老版本的主要差异;ＧＢ／Ｔ８５６７新老版本的主要差异;ＧＢ／Ｔ８５６７新老版本的主要差异;ＧＢ／Ｔ８５６７新老版本的主要差异;ＧＢ／Ｔ８５６７新老版本的主要差异;ＧＢ／Ｔ８５６７新老版本的主要差异;四、ＧＢ／Ｔ８５６７－２００6标准结构;五、文档（编制）过程5.1 概述; 文档常常是关心在软件已经实现后做些什么。然而，为了质量，软件文档编制应作为整个软件生产过程的一部分。过程计划应把文档计划包括在内。本标准也给用户和客户提供工具以保证文档过程实施。 本标准的主要活动之一是建立开发文档的广泛计划。这是必须的，因为有计划，文档编制的质量会更好，过程的效率会更高。为遵循本标准，计划必须包括风格规格说明。本标准不规定风格规格说明的内容（即不规定具体的布局和字体），但它规定风格规格说明必须覆盖什么。本标准也规定何种信息对于文档管理者是可用的和谁做评审和再生产文档。 ;5.2 文档（编制）过程的关注点;5.3 文档计划; 文档计划应包括（但不限于）以下内容： a）计划的文档的工作名称、目的、范围和限制。 b）文档的预定的读者，和使用的目的。 c）文档内容的草案表，带有估计的页数和其他媒体的等效细节。 d）交付：打印副本数，是否提供电子副本，磁盘和文件格式（包括软件版本）和在何处交付。 e）版权的拥有者和任何其他所有权。 l????这是复杂的问题，应在合同中规定。 ; f）适当处，包括每个文档的安全或机密级。 g）管理文档开发过程的步骤和控制，包括存储、检索、后备、处理和质量保证（若要求）。 h）所用的生产方法、工具和工具版本。 i）文档开发人员所在的队伍的结构，任选地，包括队伍选择计划。 l??在文档编写和生产的不同阶段中的工作人员，需要不同的技巧。编写人员可能要求对正在编写的系统有好的知识加上写文档的经验；编辑人员可能要求有编辑经验而对系统知识无要求；版面艺术家可能对所用的版面工具外，无任何知识要求。 ; j）项目依赖。 k）所要求的人时和成本。 l）项目资源需求，包括需方提供的信息和其他资源。 m）在软件开发期间，软件变更传送信息给文档管理者的方法。 n）文档的变更控制和维护的计划（任选）。 o）实现后评审的计划（任选）。 ; p）显示适当的里程碑的时间表，包括： 1）文档计划批准； 对于文档的每一项应重复。 l??文档计划宜2）每个草案的准备、评审和改正； 3）可用性测试； 4）打印、装订和发布。 若适当，这些活动的每一个在文档的开发开始以前准备与批准，以保证所有部门同意目标和所用的方法。批准后，计划宜尽可能广泛地分发；分发宜包括所有文档开发人员和可能包括需方人员及子合同方。 ;5.3.2 文档计划控制 在正式同意后，文档管理者应控制文档计划和它的发布。文档管理者应保持一份文档计划副本的分发的清单。若以后文档计划变更了（得到文档管理者和需方的同意），文档管理者应保证所有得到文档计划副本的人员，应得到变更通知。 l? 因为，计划的过时的副本可能引起问题，文档管理者宜禁止计划的未控制的副本并制订计划的所有副本已经更新的审核过程。 ;5.4 文档开发;5.5 评审; 用户文档的评审应由需方实现，包括当需要时与文档管理者讨论。 l??评审的目的是保证提交的材料是完整的和正确的并满足了在合同和文档计划中定义的需方的需要。 评审宜由合适的有资格的人员执行，这些人员被授权请求变更和批准文档的内容。 l??需方宜限止评审人员数为评审功能所必需的那些。 需方在批准每个用户文档草案之前，应保证文档的安全和合法。 为评审交付的文档应包括从文档管理者来的说明书，说明评审的目的和评审员的职责。 ; l? 注1：在需方和文档管理者之间在整个开发过程期间维持良好的通信会提高文档的质量并利于评审成功。这宜包括非正式的讨论和尽早地提供样板或初始材料给需方。 l??注2：在要求的变更超出了合同和文档计划的范围时，需要变更合同。 l??注3：评审过程不免除文档管理者，他们的责任是试图尽可能保证文档的精确和完整。 l??注4：从评审的结果而来的需方的评论结果宜用或是加上标记的草案或用有适当的参考的方式写评论。需方宜保持变更的副本为了与下一草案相比较。评论应使文档开发人员能实现所要求的变更而不需要评审人员的进一步解释。 l??注5：对于大的、复杂的系统或正在写文档时系统仍在开发，可能需要多于两次草案和一次校样。在这样情况下，最多的草案数宜在需方和文档管理者之间同意并