如何编写php软件开发文档

如何编写php软件开发文档?

1标题
软件系统名称和标识符
模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号（说明本卷宗在整个卷宗中的序号）
编排日期（说明整个卷宗最近的一次编排日期）

2模块开发情况表

3功能说明
扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。
4设计说明
说明本模块（或本组模块）的设计考虑，包括：
a． 在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；
b． 在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；
c． 在编制目前已通过全部测试的源代码时实际使用的设计考虑。
5原代码清单
要给出所产生的本模块（或本组模块）的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。
6测试说明
说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
7复审的结论
把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。

以上是如何编写php软件开发文档的详细内容。更多信息请关注PHP中文网其他相关文章！