技术报告编写规范

技术报告编写规范文件编号：NW506102生效日期：2000.3.20受控编号：密级：秘密版次：Ver2.1修改状态：总页数8正文4附录4编制：孟莉审核：袁淮批准：孟莉沈阳东大阿尔派软件股份有限公司（版权所有，翻版必究）技术报告编写规范Ver2.1P-2/4沈阳东大阿尔派软件股份有限公司文件修改控制修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期技术报告编写规范Ver2.1P-3/4沈阳东大阿尔派软件股份有限公司目录1.目的2.适用范围3.术语及缩略语4.编写规范4.1排版规范4.2模板使用5.引用文件6.附录技术报告编写规范Ver2.1P-4/4沈阳东大阿尔派软件股份有限公司1.目的技术报告编写规范主要描述在软件产品或软件项目开发完成时所需编写的技术报告应该包含的内容，使得本公司编写的技术报告便于软件产品或软件项目日后的维护、交接和代码重用。2.适用范围适用于本公司软件产品或软件项目的技术报告的编写。3.术语及缩略语本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。4.编写规范4.1排版规范1）整个规范由2节构成，模板单独一节。2）正文样式采用“规范正文”。3）标题编号采用每节独立编号。4.2模板使用1）拷贝规范。2）删除第一节（技术报告封面前的所有页）。3）在修改完内容后，更新目录域和相关的页数域。5.引用文件(无)6.附录以下部分为技术报告的模板。密级：机密文档编号：第版分册名称：第册/共册项目名称（项目编号）技术报告（部门名称）沈阳东大阿尔派软件股份有限公司总页数正文附录生效日期：年月日编制：审核：批准：技术报告2/4沈阳东大阿尔派软件股份有限公司2目录1.引言.................................................................................................................................................31.1目的........................................................................................................................................31.2背景........................................................................................................................................31.3术语........................................................................................................................................31.4人员........................................................................................................................................31.5参考资料................................................................................................................................32.系统概述.........................................................................................................................................32.1适用范围及系统特性简要说明............................................................................................32.2子系统及其模块的划分........................................................................................................32.3系统运行环境........................................................................................................................33.文件一览.........................................................................................................................................43.1系统运行文件一览................................................................................................................43.2源程序文件一览....................................................................................................................43.3函数、类、事件一览（可选）............................................................................................44.数据库结构.....................................................................................................................................45.可重用子系统或模块.....................................................................................................................46.总结与展望.....................................................................................................................................4技术报告3/4沈阳东大阿尔派软件股份有限公司31.引言1.1目的说明编写本《技术报告》的目的。1.2背景说明理解本报告所需的背景，如与公司其它软件之间的联系等。1.3术语列出本报告中专门术语的定义和英文缩写词的原词组。1.4人员给出本软件的开发人员。姓名部门职务或角色电话1.5参考资料：列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布日期和出版单位。编号资料名称简介作者日期出版单位列出编写本报告时需查阅的Intenet上杂志、专业著作、技术标准以及他们的网址。网点简介2.系统概述2.1适用范围及系统特性简要说明简述本软件系统适用的领域、功能要点、产品化程度。2.2子系统及其模块的划分给出系统中各个子系统及其模块简要的功能描述，并用图形的方式给出各个子系统及其模块之间的关系。如果本软件系统是一个更大的系统的一个组成部分，则还要说明本软件系统与这个更大的系统中的其他各组成部分之间的关系。2.3系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置。软件环境包括：操作系统、数据库、以及其它支撑软件；硬件环境包括：主机类型、网络类型、存储器容量、其它特殊设备。如有同等作用的内容或文件（如已编写的《系统设计报告》）则可直接在此引述该文件名及归档的部门即可。技术报告4/4沈阳东大阿尔派软件股份有限公司43.文件一览3.1系统运行文件一览给出本软件系统(或分别给出各子系统)运行时其各种文件系统目录、文件一览表，并说明其意义、内容等。3.2源程序文件一览给出本软件系统(或分别给出各子系统)源程序文件及头文件目录、文件一览表，并简要说明各源程序文件所包含的内容、与子系统及其模块的对应关系。3.3函数、类、事件一览（可选）按照源程序文件一览的顺序，给出源程序文件中函数、类、事件的说明。具体要求如下：1)函数的功能：必要时简要给出算法；2)函数调用参数及返回值：说明各参数及返回值的作用、意义及其取值范围。4.数据库结构对于MIS等使用数据库的项目，必须详细说明数据库中各数据库表之间的关系，详细说明各数据库表中每一个字段的作用、意义及其取值范围。如果其取值范围是可枚举的，应说明每一取值的含义。如有同等作用的内容或文件（如已编写的《系统设计报告》）则可直接在此引述该文件名及归档的部门即可。5.可重用子系统或模块以列表的方式给出本软件系统中可被其它系统应用的子系统或模块，说明这些可重用子系统或模块的应用范围。6.总结与展望说明本软件系统在开发过程中的经验与教训，尚存的功能、可靠性等方面的问题，该软件系统以后的发展方向及再开发策略。