软件开发技术文档编写规范,软件开发技术文档有哪些

软件开发中经常用到什么文件？

官方API或官方文档

软件开发文档的内容是什么

例如，在开发阶段，对文档化的需求程度等等，如果经过CMM考核，则会出现更多的文档

通常以项目开发过程为划分标准，基本的有可行性研究报告（若是一个新项目且未确定的或应客户要求时需要，实际上大部份公司很少有这文档）

客户需求说明（用户加开发人员的联合确认）

软件需求规格说明

设计说明（体系结构、详细设计）测试用例用户手册实现代码

这些文件，包含了一些分析和设计图形，例如用例图，数据库结构和ER图

当然，项目计划，测试计划都要计算进去

还有一些（如CMM要求的）

风险，估计，质量保证，配置管理，定义模板，度量数据库，等等

具体所需文档有多大是根据项目实际这一方面来确定的，可以借鉴一些软件工程类书籍来进行

软件开发要编制什么样的文件？

模块开发卷（GB8567——88）

1题目

软件系统名称及标识符

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

程序编制员署名

卷宗中订正文本序号

订正完成日期

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

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

2、模块开发情况表

3。功能描述

扼要地说明了该模块（或本组模块）所具有的作用，以输入为主，请求加工，输出为辅。其目的在于让用户了解该功能模块的使用方法和步骤。系统设计说明书可节选。为了便于理解，还可将其与其他相关功能模块进行比较和分析。同时，列举了软件需求说明书上关于上述功能描述的章节，条文和款目。

4设计描述

描述了该模块（或本组模块）在设计上的考虑因素，其中包括：

a。系统设计说明书上关于本模块（或本组模块）的设计考虑因素的描述，包括该模块在软件系统中的级别，它与其它模块之间的界面；

b。程序设计说明书关于本模块（或本组模块）设计方面的考虑，包括该模块算法，处理过程、所涉及的是对数据文卷的设计约束、驱动方式与出错信息的关系等等；

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

5原代码列表

要提供生成的这个模块（或本组模块）中第一个没有语法错源代码清单和已经通过所有测试的目前有效源代码清单。

6试验说明

说明应直接通过该模块（或本组模块）中的每一个测试，包括这类检测分别标识符及其编号、开展这些试验是为了实现、使用配置及投入、期望和实际产出。

7复审结论

将实际测试结果，与软件需求说明书，系统设计说明书，程序设计说明书所规定的需求进行对比并给出了结论。

软件开发文档要怎么写？

如果了解软件文档有什么价值的话，那何不常用？在我们使用时遇到的问题可能是软件文档本身有缺陷。对新手来说，多数软件文档中有许多如下所述的问题：

·语法不好和/或拼写错误的单词

·不够全面

·到期或失实

·篇幅过长

http://www.mscto .康姆 http://www.mscto .康姆

·首字母缩写未予说明，或者用语不够专业

http://www.mscto .康姆 http://www.mscto .康姆

·很难查找资料，也很难从文件中确定软件开发网的位置

之所以会出现上述问题，主要是因为人们对软件文档普遍重视不够所致。大多数公司的软件开发部门都把重点放在了技术研发和测试方面。项目预算迫使重大活动用于发展工作，在这里，管理层可以轻而易举地发现其利益。在这种情况下，软件文档往往会被视为一种不需要进行投资、但却可以带来额外效益的东西。值得花费费用的文档工作，一般比较主观，并一般描绘成所需回避的代价，因为它们被认为不能产生投资回报（ROI）。因此，大多数项目管理者会忽略一些重要而非次要的文档。许多项目经理都把顾客要求的最小文件视为“镀金”文件。

软件开发网

软件文档另一令人头痛的根源在于文档的编写者。因为许多软件开发人员都没有使用过自己开发的软件文档，所以，软件文档被认为是一种不需要修改或更改就能得到用户满意效果的产品。许多应用程序开发经理都感觉到软件文档在开发工作中处于标准地位，所以，需要其开发人员进行编码，同时还要编制软件文档。

尽管这种说法有道理，但不能把开发人员视为文档作者。事实上，大多数开发者并不是真正意义上的开发人员，而是被培训过的程序员。非常简单的是技术人员只是训练怎么去发展，而且也没训练过怎么去编写文件。由于技术作家和商业分析人员都有一定的软件开发经验，因此他们的软件文档也会比一般用户使用更多。针对这一问题，许多应用程序开发经理试图通过雇佣某些技术性写手或者商业分析人员改善其软件文档。由此产生了与此相对应的现象：无论是技术写手还是商业分析人员，技术技能一般都很有限。

解决方案取决于文档，文档要迎合它潜在的读者。文档可以包含用户期望的各种形式，包括文本、图像或其他类型的信息。在此方面，通用规则就是需要采用一种协同工作的方式进行文档写作，此法可使开发人员与写手各显神通。在某些情况下，这些共同的特征使得文档能满足不同用户的需求。如潜在读者为系统设计人员等，然后，开发人员应给出详尽的投入，但让技术写手来整理、编辑内容，让文件合乎语法。

无论潜在读者或入选读者，软件文档质量高低与可使用性有关，下列6个属性可用于衡量软件文档是否可用：

·适用性：该文件是否提供有关资料？

·合时性：文件是否提供了那个时代的资料？

·正确性：文件中给出的数据是否正确？

·完整性：文件是否充分详尽？

·可用性——文件是否随手可得？

·可使用性，能迅速、直观的查找

希望对大家有所帮助

参考资料: http://www.mscto .康姆/web/200811155327.html 参考资料: http://www.mscto .康姆/web/200811155327.html