电子开发文档怎么写（如何写电子开发文档文章)

开发文档都有哪些

软件系统名称和标识符

模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）

程序编制员签名

卷宗的修改文本序号

修改完成日期

卷宗序号（说明本卷宗在整个卷宗中的序号）

编排日期（说明整个卷宗最近的一次编排日期）

2模块开发情况表

3功能说明

扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。

4设计说明

说明本模块（或本组模块）的设计考虑，包括：

a． 在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；

b． 在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；

c． 在编制目前已通过全部测试的源代码时实际使用的设计考虑。

5原代码清单

要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。

6测试说明

说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。

7复审的结论

把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。

1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。

2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。

3)作为开发人员在一定阶段的工作成果和结束标志。

4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。

5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。

6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。

文档在各类人员、计算机之间的多种桥梁作用中看出：

既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发

规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。

ps：软件开发文档包括：

操作手册

维护修改建议

软件需求（规格）说明书

开发文档 软件需求（规格）说明书

数据要求说明书

概要设计说明书

详细设计说明书

可行性研究报告

项目开发计划

管理文档 项目开发计划

测试计划

测试报告

开发进度月报

开发总结报告

......