XXXX 系统
2022 年 6 月 5 日
科瑞明开发技术文档
更新记录
创建日期
原作者
完成日期
变更日期
变更人
变更摘要
变更记录
- 1 -
科瑞明开发技术文档
目 录
1.
第一章 前言 .................................................... - 3 -
1. 系统名称 .............................................. - 3 -
2. 需求提出单位 .......................................... - 3 -
3. 内容简介 .............................................. - 3 -
4. 参考资料 .............................................. - 3 -
第二章 程序总体介绍 ............................................ - 4 -
第三章 模块清单列表 ............................................ - 5 -
第四章 模块开发技术文档 ........................................ - 6 -
XX 模块名称 ............................................ - 6 -
1.1. 模块功能 .......................................... - 6 -
1.2. 输入输出信息 ...................................... - 6 -
1.3. 使用文件和表格 .................................... - 6 -
1.4. 模块间接口 ........................................ - 7 -
1.5. 模块结构图或流程图 ................................ - 7 -
1.6. 处理描述 .......................................... - 7 -
1.7. 有关事项(根据具体情况决定有无此节) .............. - 7 -
1.8. 测试说明 .......................................... - 7 -
1.9. 复审的结论 ........................................ - 8 -
XX 模块名称 ............................................ - 8 -
2.
- 2 -
科瑞明开发技术文档
第一章 前言
1. 系统名称
指出方案/系统的名称(中文全称、简称,英文全称、简称含版本号)。
2. 需求提出单位
指出用户/需求提出部门的名称。
3. 内容简介
介绍本文档的内容、编写情况、参加人员等。
4. 参考资料
列出引用参考的文件资料的名称。
- 3 -
科瑞明开发技术文档
第二章 程序总体介绍
对所有程序作一个整体概括说明。
- 4 -
科瑞明开发技术文档
第三章 模块清单列表
模块编号
标识名称
描述名称
语言
用途
编制者
日期
备注
- 5 -
科瑞明开发技术文档
第四章 模块开发技术文档
1. XX 模块名称
说明:
A. 模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的
功能标识代替模块名)
B. 程序编制员签名
C. 卷宗的修改文本序号
D. 修改完成日期
1.1.模块功能
扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。
可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明
的章、条、款。
1.2.输入输出信息
本模块处理的所有输入数据格式(包括数据项的名称、标识和位数等)及处
理后的返回信息或输出数据格式等,须详细说明。
1.3.使用文件和表格
说明:
A. 本模块处理过程中所用到的文件名、访问方式等;
B. 所用到的内存表格及参考或更新方式等予以说明;
C. 若文件和表格为本程序专用,须写出具体格式。
- 6 -
1.4.模块间接口
科瑞明开发技术文档
本模块有调用其它模块或本模块时,须指明调用与非调用的关系。包括调用
模块名,被调用模块的入口名以及参数的使用方法。
1.5.模块结构图或流程图
用结构化的程序设计要求画出本程序处理的流程图或结构图,并要详细描述
各层次的关系及必要的图解。
1.6.处理描述
说明:
A. 用文字叙述的方法,对本模块的处理步骤和方法很详尽的描述(包括所用
到的计算公式和要求的计算精度等);
B. 指出本模块的有关限制;
C. 要求详细描述本模块在不正常情况下所做的各种特殊处理。(包括出错
代码等)。
1.7.有关事项(根据具体情况决定有无此节)
主要说明本程序操作方法,包括何时启动,启动命令处理中有哪些显示和应
答要求等,以及其它有关的事项在此逐一说明。
1.8.测试说明
说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的
标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的
输出。
- 7 -