1.程序名称;包括反映程序功能的文字名称和标识符。
2.程序所属的系统、子系统或模块的名称。
3.编写程序所需使用的语言。
4.输入的方式和格式:当程序有多种输入时,分别对每种输入方式与格式做出具体而细致
的说明。
5.输出的方式与格式:当程序有多种内容按不同方式输出时,分别说明不同内容按不同方
式输出时的格式。
6.程序处理过程说明:包括程序中使用的计算公式,数学模型和控制方法等。
7.程序运行环境说明:对程序运行所需要的输入输出设备的类型和数量,计算机的内存及
硬盘容量,支持程序运行的 *** 作系统等内容进行说明。
由于种种原因,在实际工作中不太重视程序说明书的编写工作。这既不利于程序的设计工作,更不利于对程序的修改和维护工作。因为系统投入运行后,需要经常根据情况的变化进行调整和修改,如果没有完善的文档资料,维护、修改就很难进行。
额……~肯定是有相关标准的吧~话说我们每次做项目的文档也都不太一样~
我大概描述下我两年前的一个文档吧~(在邮箱里找到的)
1.项目概述:
项目名称:
项目用途:
2.需求分析
业务需求
用户需求
功能需求
性能需求
3. 系统功能模型
4.系统设计
4.1 总体设计
4.2 详细设计
4.2.1 系统的结构模型
4.2.2 系统的动态模型
4.2.3 主要程序说明
5.主要代码实现
其他描述:
6.测试:
黑盒测试:
白盒测试:
7.系统维护
8.参考文献
9.结束语
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)