- 本文原创作者：谷哥的小弟
- 作者博客地址：http://blog.csdn.net/lfdfhl
- 本文参考资料：电子工业出版社《软件文档写作教程》 马平，黄冬梅编著
开发文档编制策略
文档策略是由上级(资深)管理者制订的，对下级开发单位或开发人员提供指导。策略规定主要的方向不是做什么或如何做的详细说明。一般说来，文档编制策略陈述要明确，并通告到每个人且理解它，进而使策略被他们贯彻实施。
支持有效文档策略的基本条件有以下几点。
- 文档需要覆盖整个软件生存期
在项目早期几个阶段就要求有文档，而且在贯穿软件开发过程中必须是可用的和可维护的。在开发完成后，文档应满足软件的使用、维护、增强、转换或传输。 - 文档应是可管理的
指导和控制文档的获得维护，管理者和发行专家应准备文档产品、进度、可靠性、资源，质量保证和评审规程的详细计划大纲。 - 文档应适合于它的读者
读者可能是管理者、分析员、无计算机经验的专业人员、维护人员、文书人员等。根据任务的执行，他们要求不同的材料表示和不同的详细程度。针对不同的读者，发行专家应负责设计不同类型的文档。 - 文档效应应贯穿到软件的整个开发过程中
在软件开发的整个过程中，应充分体现文档的作用和限制，即文档应指导全部开发过程。 - 文档标准应被标识和使用
应尽可能地采纳现行的标准，若没有合适的现行标准，必要时应研制适用的标准或指南。 - 应规定支持工具
工具有助于开发和维护软件产品，包括文档。因此尽可能地使用工具是经济的、可行的
开发文档编制标准
开发文档的编制应尽可能地采用现行的国家和国际标准，若现行的标准不适用，机构应制订自己的标准。
1 .选择软件生存期模型
现有的一些软件生存期模型，对于不同的阶段有不同的词汇，从软件文档的观点来看，采用哪种模型都无关紧要，只要阶段和相应的文档是清晰定义的、已计划的，并且对于任何具体软件项目是能遵循的。因此，管理者应选择一个软件生存期模型并保证该模型在他们机构内是适用的。
管理者会发现所进行的阶段和相应任务的定义有助于监控软件项目的进展。相应于特定阶段生成的文档可用做该阶段的评审、通过和完成的检验点，而这种检验应在下一阶段开始前进行。
2 .规定文档类型和内容
下面给出软件文档主要类型的大纲，这个大纲不是详尽的或最后的，但适合作为主要类型软件文档的检验表。而管理者应规定何时定义他们的标准文档类型。
软件文档归入如下三种类别：
• 开发文档一描述开发过程本身。
• 管理文档——记录项目管理的信息。
• 用户文档——记录用户所需的信息。
• .确定文档的质量等级
开发文档编制指南
仅仅依据规章、传统的做法或合同的要求去制作文档是不够的。管理者还必须确定文档的质量要求以及如何达到和保证质量要求。
质量要求的确定取决于可得到的资源、项目的大小和风险，可以对该产品的每个文档的格式及详细程度做出明确的规定。
每个文档的质量必须在文档计划期间就有明确的规定，文档的质量可以按文档的形式和列出的要求划分为4级。
最低限度文档（1级文档）：1级文档适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。
内部文档（2级文档）：2级文档可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外，2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。
工作文档（3级文档）：3级文档适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的程序。
正式文档（4级文档）：4级文档适合那些要正式发行供普遍使用的软件产品。关键性程序或具有重复管理应用性质（如工资计算）的程序需要4级文档。4级文档遵守GB8567的有关规定。
质量方面需要考虑的问题既要包含文档的结构，也要包含文档的内容。文档内容可以根据正确性、完整性和明确性来判断。而文档结构由各个组成部分的顺序和总体安排的简单性来测定。要达到这4个质量等级，需要的投入和资源逐级增加，质量保证机构必须处于适当的行政地位以保证达到期望的质量等级。
