技术文档说明书的模板.doc

科瑞明开发技术文档

XXXX系统

2024年5月6日

更新记录
创建日期

原作者

完成日期

变更记录
变更日期
变更人
变更摘要

目 录
第一章 前言 - 3 -
1. 系统名称 - 3 -
2. 需求提出单位 - 3 -
3. 内容简介 - 3 -
4. 参考资料 - 3 -
第二章 程序总体介绍 - 4 -
第三章 模块清单列表 - 5 -
第四章 模块开发技术文档 - 6 -
1. 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 -
2. XX模块名称 - 8 -

第一章 前言
1. 系统名称
指出方案/系统的名称（中文全称、简称，英文全称、简称含版本号）。
2. 需求提出单位
指出用户/需求提出部门的名称。
3. 内容简介
介绍本文档的内容、编写情况、参加人员等。
4. 参考资料
列出引用参考的文件资料的名称。
第二章 程序总体介绍
对所有程序作一个整体概括说明。
第三章 模块清单列表
模块编号
标识名称
描述名称
语言
用途
编制者
日期
备注

第四章 模块开发技术文档
1. XX模块名称
说明：
A. 模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能标识代替模块名）
B. 程序编制员签名
C. 卷宗的修改文本序号
D. 修改完成日期
1.1. 模块功能
扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。
1.2. 输入输出信息
本模块处理的所有输入数据格式（包括数据项的名称、标识和位数等）及处理后的返回信息或输出数据格式等，须详细说明。
1.3. 使用文件和表格
说明：
A. 本模块处理过程中所用到的文件名、访问方式等；
B. 所用到的内存表格及参考或更新方式等予以说明；
C. 若文件和表格为本程序专用，须写出具体格式。
1.4. 模块间接口
本模块有调用其它模块或本模块时，须指明调用与非调用的关系。包括调用模块名，被调用模块的入口名以及参数的使用方法。
1.5. 模块结构图或流程图
用结构化的程序设计要求画出本程序处理的流程图或结构图，并要详细描述各层次的关系及必要的图解。
1.6. 处理描述
说明：
A. 用文字叙述的方法，对本模块的处理步骤和方法很详尽的描述(包括所用到的计算公式和要求的计算精度等)；
B. 指出本模块的有关限制；
C. 要求详细描述本模块在不正常情况下所做的各种特殊处理。（包括出错代码等）。
1.7. 有关事项（根据具体情况决定有无此节）
主要说明本程序操作方法，包括何时启动，启动命令处理中有哪些显示和应答要求等，以及其它有关的事项在此逐一说明。
1.8. 测试说明
说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
1.9. 复审的结论
把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。
2. XX模块名称
同1的格式，对系统的其它模块进行描述。
其中专业理论知识内容包括：保安理论知识、消防业务知识、职业道德、法律常识、保安礼仪、救护知识。作技能训练内容包括：岗位操作指引、勤务技能、消防技能、军事技能。
二．培训的及要求培训目的
安全生产目标责任书
为了进一步落实安全生产责任制，做到“责、权、利”相结合，根据我公司2015年度安全生产目标的内容，现与财务部签订如下安全生产目标：
一、目标值：
1、全年人身死亡事故为零，重伤事故为零，轻伤人数为零。
2、现金安全保管，不发生盗窃事故。
3、每月足额提取安全生产费用，保障安全生产投入资金的到位。
4、安全培训合格率为100%。
二、本单位安全工作上必须做到以下内容：
1、对本单位的安全生产负直接领导责任，必须模范遵守公司的各项安全管理制度，不发布与公司安全管理制度相抵触的指令，严格履行本人的安全职责，确保安全责任制在本单位全面落实，并全力支持安全工作。
2、保证公司各项安全管理制度和管理办法在本单位内全面实施，并自觉接受公司安全部门的监督和管理。
3、在确保安全的前提下组织生产，始终把安全工作放在首位，当“安全与交货期、质量”发生矛盾时，坚持安全第一的原则。
4、参加生产碰头会时，首先汇报本单位的安全生产情况和安全问题落实情况；在安排本单位生产任务时，必须安排安全工作内容，并写入记录。
5、在公司及政府的安全检查中杜绝各类违章现象。
6、组织本部门积极参加安全检查，做到有检查、有整改，记录全。
7、以身作则，不违章指挥、不违章操作。对发现的各类违章现象负有查禁的责任，同时要予以查处。
8、虚心接受员工提出的问题，杜绝不接受或盲目指挥；
9、发生事故，应立即报告主管领导，按照“四不放过”的原则召开事故分析会，提出整改措施和对责任者的处理意见，并填写事故登记表，严禁隐瞒不报或降低对责任者的处罚标准。
10、必须按规定对单位员工进行培训和新员工上岗教育；
11、严格执行公司安全生产十六项禁令，保证本单位所有人员不违章作业。
三、 安全奖惩：
1、对于全年实现安全目标的按照公司生产现场管理规定和工作说明书进行考核奖励；对于未实现安全目标的按照公司规定进行处罚。
2、每月接受主管领导指派人员对安全生产责任状的落

- 9 -