技术文档编写格式管理办法

《技术文档编写格式管理办法》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、时代视通软件技术有限公司『技术文件名称[空格][空格]版本号，宋体五号居左』技术文件技术文件名称：[单击此处键入文件名称][宋][小四]技术文件编号：版本：[单击此处键入版本号][宋][三号]文件质量等级：共[键入总页数]页(包括封面)拟制审核会签标准化批准时代视通软件技术有限公司第5页共页时代视通软件技术有限公司『技术文件名称[空格][空格]版本号，宋体五号居左』目录[单击此处键入目录内容]第5页共页时代视通软件技术有限公司『技术文件名称[空格][空格]版本号，宋体五号居左』1引言1.1范围[注：本文档包含的内容及有关文档的说明]1.2

2、参考资料[注：与本文档相关的文档以及参考书籍]1.3术语、缩略词[注：此项可略过]2概述2.1该模块的地位和作用[注：该模块与上下级模块、同级相关模块的关系，该模块的作用]2.2该模块完成的功能[注：详细说明该模块完成软件系统中相应的功能]2.3该模块的组成[注：说明组成该模块的子模块]3数据说明3.1常量说明[注：键入内容]3.2变量说明[注：全局变量和重要的局部变量说明]3.3数据类型说明[注：包括类型说明、对象类的层次结构说明等]3.4数据库说明[注：结构定义、数据量等（视各模块的具体情况可选）]3.5其他说明[第5页共页时代视通软

3、件技术有限公司『技术文件名称[空格][空格]版本号，宋体五号居左』注：需要的大量内存说明、重要算法说明、通信协议格式说明、任务和消息队列说明、进程和线程说明等（视各模块的具体情况可选）]1模块说明[注：不包含子模块时此项则选用]1.1原型定义1.2输入、输出和错误代码说明[注：输出包括参数输出、消息队列和事件等]1.3调用关系1.4流程图2模块结构图[注：包含子模块此项则选用，以层次图的形式说明模块和子模块的关系]3需说明的其他事项[注：视各模块的具体情况此项可选。]3.1源文件目录组织[注：以相对路径给出源文件目录组织。]3.2各文件包

4、含的子模块[注：以表格形式列出各文件包含的子模块。]3.3其他4子模块说明[注：包含子模块此项则选用]4.1原型定义4.2输入、输出和错误代码说明[注：输出包括参数输出、消息队列和事件等]4.3调用关系第5页共页时代视通软件技术有限公司『技术文件名称[空格][空格]版本号，宋体五号居左』1.1功能1.2流程图第5页共页