软件文档编制规范 军标 文档编制规范

软件开发文档编制的质量要求是什么呢？

最常见到的情况是，软件开发过程中不能按给出的进度， 分阶段及时完成文档的编制工作，而是在开发工作接近完成时集中人力和时间专门编写文档。

另一方面，和程序工作相比，许多 人对编制文档不感兴趣。

于是在程序工作完成以后，不得不应付一下，把要求提供的文档赶写出来。

这样的做法不可能得到高质量的文档。

实际上，要得到真正高质量的文档并不容易，除去应在认识上对文档工作给予足够的重视外，常常需要经过编写初稿，听取意见进行修改，甚至要经过重新改写的过程。

高质量的文档应当体现在以下一些方面： ①针对性 文档编制以前应分清读者对象，按不同的类型、不同层次的读者，决定怎样适应他们的需要。

例如，管理文档主要是面 向管理人员的，用户文档主要是面向用户的，这两类文档不应像开发 文档（面向软件开发人员）那样过多地使用软件的专业术语。

②精确性 文档的行文应当十分确切，不能出现多义性的描 述。

同一课题若干文档内容应该协调一致，应是没矛盾的。

③清晰性 文档编写应力求简明，如有可能，配以适当的图 表，以增强其清晰性。

④完整性 任何一个文档都应当是完整的、独立的，它应自成体系 。

例如，前言部分应作一般性介绍，正文给出中心内容 ，必要时还有附录，列出参考资料等。

同一课题的几个文档之间可能 有些部分相同，这些重复是必要的。

例如，同一项目的用户手册和操 作 册中关于本项目功能、性能、实现环境等方面的描述是没有差别 的。

特别要避免在文档中出现转引其它文档内容的情况。

比如，一 些段落并未具体描述，而用＂见**文档**节＂的方式，这将给 读者带来许多不便。

⑤灵活性 各个不同的软件项目，其规模和复杂程度有着许 多实际差别，不能一律看待。

图6所列文档是针对中等规模的软件而言的。

对于较小的或比较简单的项目，可做适当调整或合 并。

比如，可将用户手册和操作手册合并成用户操作手册；软件需求说明书可包括对数据的要求，从而去掉数据要求说明书；概要设 计说明书与详细设计说明书合并成软件设计说明书等。

⑥可追溯性 由于各开发阶段编制的文档与各阶段完成的工作有着紧密的关系，前后两个阶段生成的文档，随着开发工作的逐步 扩展，具有一定的继承关系。

在一个项目各开发阶段之间提供文档 必定存在着可追溯的关系。

例如，某一项软件需求，必定在设计说明 书，测试计划以至用户手册中有所体现。

必要时应能做到跟踪追查。

传统软件工程的规范有哪些？有哪些文档

在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性，有工程app打破了很多的传统软件工程的局限性。

1、 可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、 项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

4、 概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。

5、 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解，为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

7、测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。

计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

9、开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

10、项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。

11、 软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。

12、软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

13、软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。

计算机软件文档编制规范标准的意义何在？为什么

你好！你要的应该是这本《计算机软件工程规范国家标准汇编》 出版社： 中国标准出版社 ISBN: 7-5066-3238-1 出版日期： 2003 定 价： ￥115.00元 内容简介： 本汇编已出版过四个版本，此次最新出版的2003年版收入了全部现行有效的软件工程规范国家标准共33项。

本汇编按照软件工程标准体系的框架结构进行了分类，将所收标准按专业基础、软件过程、软件质量、技术与管理、工具与方法、数据等六大类分类编排，方便读者使用，有利于软件开发过程的控制、管理，提高软件质量，减少开发和维护所需费用，推动软件产业的发展。

【我咨询过，没有您说的2006版，2003版是最新的第5版】 您也可自行咨询： 【中国标准出版社】 社长兼党委书记：张健全 总编辑：白德美 地 址：北京市复兴门外三里河北街16号 邮 编：100045 电 话： 0086-10-68532852（网上书店） 0086-10-68517910（办公室兼传真） 0086-10-68517112（出版部） 0086-10-68533533（总编室兼传真） 0086-10-63729404（彩印中心）

国家强制性标准的格式

《招标投标法》第二十七条规定：“投标人应当按照招标文件的要求编制投标文 件。

投标文件应当对招标文件提出的实质性要求和条件作出响应。

招标项目属于建设施工 的，投标文件的内容应当包括拟派出的项目负责人与主要技术人员的简历、业绩和拟用于 完成招标项目的机械设备等。

”所谓实质性要求和条件，是指招标项目的价格、项目进度计划、技术规范、合同的主 要条款等，投标文件必须对之作出响应，不得遗漏、回避，更不能对招标文件进行修改或 提出任何附带条件。

对于建设工程施工招标，投标文件还应包括拟派出的项目负责人与主 要技术人员的简历、业绩和拟用于完成工程项目的机械设备等内容。

投标人拟在中标后将 中标项目的部分非主体、非关键性工作进行分包的还应在投标文件中载明。

投标文件的重要部分之一是价格文件或报价文件。

《招标投标法》规定：“投标人不 得以低于成本的价格报价、竞争。

”投标人以低于成本的价格报价，是一种不正当的竞争 行为，可能会造成偷工减料、以次充好等不正当手段来降低成本从而避免亏损。

这样，就 会给市场经济秩序造成损害，给建设工程的质量带来隐患，因此，必须禁止。

不过，一些 投标人以长远利益出发，放弃短期利益，不要利润，仅以成本价投标，这也是合法的竞争 手段，这是法律保护的。

这里所说的成本，应该包含社会平均成本，并综合考虑各种价格 差别因素。

此外，投标文件还有数量、密封等要求。

如有的招标文件规定，不能使用活页夹的形 式；投标文件必须一正多副；经济标或价格标不能与技术标混合装订等要求，违反者或严 重者会被否决投标或废标。

EIA文件编制的要求是什么？

⑴EIA文件应概括地反映EIA的全部工作，环境现状调查应全面、深入，主要环境问题应阐述清楚，重点应突出，论点应明确，EP措施应可行、有效，评价结论应明确。

⑵文字应简洁、准确，文本应规范，计量单位应标准化，数据应可靠，资料应翔实，并尽量采用能反映需求信息的图表和照片。

⑶资料表述应清楚，利于阅读和审查，相关数据、应用模式须编入附录，并说明引用来源；所参考的主要文献应注意时效性，并列出目录。

⑷跨行业CP的EIA，或评价内容较多时，其EI报告书中各专项评 价根据需要可繁可简，必要时，其重点专项评价应另编专项评价分报告，特殊技术问题另编 专题技术报告。

gb/t 8567

GB/T 8567-2006 计算机软件文档编制规范。

现行国家标准，根据GB/T 8566-2001《信息技术 软件生存周期过程》的规定，主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。

该标准原则上适用于所有类型的软件产品的开发过程和管理过程。

使用者可根据实际情况对标准进行适当剪裁（可剪裁所需的文档类型，也可对规范的内容作适当裁剪）。

软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的内部文档（开发文档）两类。

转载请注明出处51数据库 » 软件文档编制规范 军标