(技术规范标准)技术报告编写规范_第1页
(技术规范标准)技术报告编写规范_第2页
(技术规范标准)技术报告编写规范_第3页
(技术规范标准)技术报告编写规范_第4页
(技术规范标准)技术报告编写规范_第5页
已阅读5页,还剩8页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

技术报告编写规范技术报告编写规范 (技术规范标准)技术报告编写规范技术报告编写规范技术报告编写规范技术报告编写规范2.适用范围3.术语及缩略语4.编写规范4.1排版规范4.2模板使用6.附录1.目的技术报告编写规范主要描述在软件产品或软件项目开发完成时所需编写的技术报告应该包含的内容,使得本公司编写的技术报告便于软件产品或软件项目日后的维护、交接和代码重用。2.适用范围适用于本公司软件产品或软件项目的技术报告的编写。3.术语及缩略语4.编写规范1)整个规范由2节构成,模板单独一节。2)正文样式采用“规范正文”。3)标题编号采用每节独立编号。2)删除第一节(技术报告封面前的所有页)。5.引用文件(无)6.附录告的模板。技术报告密1/4:第册/共册项目名称(项目编号) (部门名称)批准:目的3背景3术语3人员3参考资料32.1适用范围及系统特性简要说明32.2子系统及其模块的划分32.3系统运行环境3系统运行文件一览4源程序文件一览43.3函数、类、事件一览(可选)44.数据库结构45.可重用子系统或模块4技术报告2/41.引言说明编写本《技术报告》的目的。说明理解本报告所需的背景,如与公司其它软件之间的联系等。列出本报告中专门术语的定义和英文缩写词的原词组。给出本软件的开发人员。列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布址。2.系统概述明领域、功能要点、产品化程度。给出系统中各个子系统及其模块简要的功能描述,并用图形的方式给出各个子系统及其模块之间的关系。如果本软件系统是一个更大的系统的一个组成部分,则还要说明本软件系统与这个更大的系统中的其他各组成部分之间的关系。备分布图及设备上相应软件配置。软件环境包括:操作系统、数据库、以及其它支撑软件;硬件环境包括:主机类型、网络类型、存储器容量、其它特殊设备。如有同等作用的内容或文件(如已编写的《系统设计报告》)则可直接在此引述该文件名及归档的部门即可。3.文件一览给出本软件系统(或分别给出各子系统)运行时其各种文件系统目录、文件一技术报告3/4给出本软件系统(或分别给出各子系统)源程序文件及头文件目录、文件一览3.3函数、类、事件一览(可选)顺序,给出源程序文件中函数、类、事件的说明。具体要求如下:给出算法;2)函数调用参数及返回值:说明各参数及返回值的作用、意义及其取值范4.数据库结构系,详细说明各数据库表中每一个字段的作用、意义及其取值范围。如果其取值范围是可枚举的,应说明每一取值的含义。如有同等作用的内容或文件 (如已编写的《系统设计报告》)则可直接在此引述该文件名及归档的部门即可。5.可重用子系统或模块的方式给出本软件系统中可被其它系统应用的子系统或模块,说明这些可重用子系统或模块

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论