设计文档编写规范.doc

深圳市兆日实业有限公司作业指导书文 件 编 号WI4.2-10版本修改状态B0标题设计文档编写规范页 码第45页 43页日期修改状态页码更改说明修改人0新拟制编写陈朝梅、徐阳部门日期2000年10月20日审核部门日期 年 月 日批准部门日期 年 月 日目 录一.项目立项文档编写规范4(1)立项申请报告4(2)可行性研究报告5(3)可行性研究评审报告7(4)产品规格说明书8二总体方案书编写规范9三软件设计文档编写规范11(1)软件需求规格说明书11(2)软件概要设计说明书15(3)软件详细设计说明书18(4)通讯协议说明书19(5)函数调用协议说明书20(6)系统对接联调说明书20(7)软件测试计划21(8)软件测试报告23四硬件设计文档编写规范24(1)硬件需求规格说明书24(2)硬件概要设计说明书25(3)单板硬件概要设计说明书26(4)单板软件概要设计说明书26(5)单板硬件详细设计说明书27(6)单板软件详细设计说明书28(7)单板硬件测试报告29(8)单板软件测试报告30(9)硬件系统联调报告30五结构、包装设计文档编写规范31(1)结构概要设计说明书31(2)结构详细设计说明书31(3)包装详细设计说明书32六产品移交文档编写规范33(1)生产移交说明书33(3)版本说明及配套表34(3)技术手册35(4)安装手册36(5)用户手册37(6)验收手册37(7)培训手册38七方案建议书编写规范38八内部验收文档编写规范39(1)验收测试方案39(2)测试单41(3)验收测试报告42一.项目立项文档编写规范(一)规范文档清单 立项申请报告 可行性研究报告 可行性研究评审报告 产品规格说明书(二)规范文档内容(1)立项申请报告本文档用来说明开发项目的主要内容和达到的目标主要技术指标、经费概算及计划完成时间等。具体编写内容如下:关键词:摘要:缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。参考资料:列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。1.引言2.项目名称、型号、项目来源、承担部门3.项目的根据及必要性4.国内外技术水平比较和发展趋势5.开发项目的目标和主要技术指标6.研究方向的选择或初步设想的方案和主要技术途径7.需要解决的重大关键技术问题8.工业标准化技术或产品以及公司内成熟技术或产品的利用情况9.关键器材、设备及必要条件10.经济合理性分析和经费11.研究进度(起止时间)12.成果形式13.项目负责人及主要成员14.其它15.评审报告预审意见:1.研究方向与公司发展领域的一致性2.关键技术的可实现性3.工业标准化技术或产品以及公司内成熟技术或产品的利用率4.进度、经费合理性5.结论及应采用的开发策略6.审核者姓名，职务或职称及日期7.其它(2)可行性研究报告本文档主要论证开发项目在技术上和经济上实现的可行性、市场可行性以及专利可行性。具体编写内容如下：关键词：摘要：缩略语说明：参考资料： 1.引言2.开发目标3.功能、性能及主要技术指标4.国内外现状及发展趋势，分析可能的替代技术或产品所引发的产品生命周期问题。5.技术可行性分析技术可行性分析可包括以下内容：l 技术关键l 技术途径现有公司的技术条件及可供利用共享的程度，可利用合作资源及知识产权现状。l 试用方法l 风险分析l 现有测试条件及设备条件6.市场可行性分析l 产品在国内外的销售数量l 市场预测的调查和估计l 竞争对手情况分析7.人力资源需求情况分阶段提出产品开发各阶段所需各类人员8.经济可行性分析经济可行性分析可包括以下内容：l 经济效益估计，包含整个估计的产品生命周期l 现有研究设备情况l 研究成本估计包括仪器设备费、样机材料费、对外合作费用、产品产生效益后的在开发费用、产品维护等费用及其它人力费用。9.专利可行性分析l 专利情报检索、分析（国内、国外）l 科技情报及对手技术分析l 专利申请策略l 制定专利技术合作、许可、借鉴、策略10.阶段计划确定各阶段的分目标 研究内容及成果形式11.详细计划和成果形式详细计划的安排及落实措施，预计进行哪种鉴定。12.对外合作单位情况和分工意见包括以下内容：l 对外合作的单位名称l 合作单位的实力分析l 委托项目及完成日期l 备注13.其它(3)可行性研究评审报告可行性研究评审报告是按立项申请报告的要求，对可行性研究报告中关于开发项目的技术可行性、经济可行性、市场可行性、专利可行性和人员需求情况的审查核实和评议，最后提出的可行性研究评审报告。具体编写内容如下:关键词:摘要:缩略语说明:参考资料:1.引言2.开发项目名称、项目代码及型号3.系统的开发目标、功能、性能和主要技术指标4.可行性评审内容4.1技术可行性评审l 技术关键l 技术途径l 现有公司的技术条件l 试验方法l 风险分析l 测试条件及设备条件4.2经济可行性评审l 经济效益评估l 现有开发环境和设备l 研究成本估算4.3市场可行性评估l 销售数量l 市场预测l 竞争对手状况4.4专利可行性评审l 国外专利状况(借鉴利用)l 国内专利状况(合作、许可)l 主要竞争对手技术现状评估l 专利申请策略5.人员需求情况评审研究小组核心成员能否到位，人员需求合理性。6.结论经过对可行性报告逐项评审后，编写可行性评审报告，除对可行性报告中的准确性给予结论意见外，若有不够之处，还可提出改进意见或存在问题，以利修改。给出应采用的开发策略。7.评审者姓名，职务或职称及日期。8.其它(4)产品规格说明书产品规格说明书是对产品用途、性能、结构特征、基本工作原理和使用等说明，具体编写内容如下:关键词:摘要:缩略语说明:参考资料:1.引言2.产品的名称和型号3.用途、性能及使用要求简述产品用途和性能，详细说明产品的使用要求(环境条件、注意事项等等)。4.技术参数5.基本工作原理按本产品的使用要求，以通俗易懂的文字和必要的图样、略图、简要说明产品的基本工作原理。6.结构特征简要说明本产品的结构特征(如外形尺寸、安装只寸等)可用外形图、安装图及有关图形符号等表明其主要的结构情况和功能原理。7.应用指南对本产品的应用环境和应用方法以及可能的配置及配套情况作全面描述，并举例说明8.其它二总体方案书编写规范关键词:摘要:缩略语说明:参考资料: 1.引言2.概述2.1系统描述2.2系统功能2.3开发环境2.4一般约束3.系统需求3.1需求分析3.2格式要求3.3功能需求3.4外部接口需求3.4.1用户界面3.4.2硬件接口3.4.3软件接口3.4.4通讯接口3.5性能需求3.5.1静态数值需求3.5.2动态数值需求3.6属性需求3.6.1可靠性3.6.2安全性3.6.3可维护性3.6.4可移植性3.6.5兼容性3.6.6可配置性3.6.7系统升级3.6.8属性需求4.其它三软件设计文档编写规范(一)规范文档清单 软件需求规格说明书 软件概要设计说明书 软件详细设计说明书 通讯协议说明书 函数调用协议说明书 软件测试方案 软件测试报告(二)规范文档内容(1)软件需求规格说明书关键词：摘要：缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。参考资料：列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。1.引言1.l背景A.用一个名字标识要开发的软件产品。B.说明软件产品的用途。1.2参考资料2.概述2.1产品的描述2.1.1如果被开发软件是独立的，则应在本节描述被开发软件概况。2.1.2如果本软件系统是一个较大的系统或项目中的一个组成部分，那么概述这个较大的系统或项目的每一个组成部分的功能，并标识其接口；标识被开发软件的主要外部接口。用图形表达其主要组成、相互联系和外部接口是非常直观的。2.2产品的功能简明叙述被开发软件的功能。内容可以直接从较高层次的规格说明中引用。2.3开发环境列出所采用的操作系统、编程语言、编程工具(编译器和调试器)、数据库平台和网络平台。2.4一般约束A.硬件的限制B.与其他应用系统的接口3.具体需求3.1功能需求描述软件产品的输入经过什么处理转换为输出，必须描述在软件中进行的基本操作。对于每一类功能或者对于每一个功能，需要描述其输入、处理和输出等需求。3.1.1功能需求13.1.1.1引言描述完成本功能的目的、所使用的方法和技术，还应当包括可以清楚说明本功能意图的来源或背景材料。3.1.1.2输入A.对本功能全部输入数据的详细描述，它们包括输入源、数量、度量单位、时间关系、有效输入的范围、精度和公差。B.操作员具体的控制需求，其中包括操作员活动的描述，控制台或操作员的位置等。C.指明引用的接口规格说明或相应的接口控制文档。3.1.1.3输出A.输出的目的地；B.有效输出的范围、精度和公差；C.非法值的处理；D.错误信息。3.l.2功能需求23.1.N功能需求N3.2外部接口需求3.2.1用户界面A.用户使用软件产品时的界面需求。例如，如果系统的用户通过显示终端操作，就必须指定如下需求：对屏幕格式的要求，报表或菜单的页面显示格式和内容，有关输入和输出的时间，用户命令的形式；B.界面的优化问题。可以简单地用一个表列出系统用户做什么或不做什么。例如，要求的是长的还是短的出错信息。与其他需求一样，这种需求也应该是可验证的。3.2.2硬件接口陈述软件产品与系统硬件设备之间每一个接口的逻辑特点。还可能包括如下事宜：要支持什么样的设备，如何支持这些设备，如何约定。3.2.3软件接口陈述其它有关软件(如数据库管理系统、操作系统、或者数学软件包)的使用方法，以及同其它相连接软件的接口。对每一个有关的软件产品，应该提供如下内容：A.名字B.助记符C.版本号对于每个与其它软件的接口，本部分应：A.描述在与本软件产品相连接的软件的基本功能，以及达到的目的。B.描述传递信息的内容、格式和接口定义。对于己有完整文档的接口，只需要引用描述该接口的文档。3.2.4通讯接口说明各种通讯接口。例如局部网络协议等。3.3性能需求从整体上说明对该软件、或人与该软件相互作用的静态或动态数值需求。3.3.1静态数值需求包括A.支持的终端数B.支持的同时操作的用户数C.处理的文件和记录数D.表和文件的大小E.对数据的精度要求，包括数学的、逻辑的和传输的精度等。3.3.2动态数值需求可以包括诸如处理和任务的数量，以及在正常情况下和峰值工作条件下，在一定时间周期中要处理的数据总数。有关响应时间、更新处理时间、数据转换和传输时间也在这一部分陈述。3.4设计约束说明需遵守的其它标准和硬件限制等设计约束。3.4.1需遵守的其它标准A.报表格式B.数据命名C.检查追踪3.4.2硬件限制描述各种影响或约束软件产品的硬件成分，应包括：A.硬件配置的特点(接口数，指令系统等)；B.主存贮器和辅助存贮器的容量；C.CPU速度。3.5属性需求在软件的具体需求中可以有若干属性。3.5.1可靠性3.5.2安全性指出保护软件的要求，以防止突然或非法的访问、使用、修改或者泄密。3.5.3可维护性指定若干需求，以确保软件是可维护的。3.5.4可移植性列出确保用户程序和用户界面兼容方面的需求，以及为把被开发软件从一种运行环境移植到另一个运行环境的需求等。3.6其它需求由于软件的类型、用户组织的特点等，某些特殊的需求可在下面描述。3.6.1故障处理列出可能发生的软件和硬件故障，并指出这些故障对各项性能指标所产生的影响以及对故障处理的要求。 (2)软件概要设计说明书关键词：摘要：缩略语说明：参考资料：1.引言A.待开发软件系统名称。B.该系统基本概念，如该系统的类型、从属地位等。D.项目代号。2.总体设计2.1系统描述2.1.1需求规定对所开发软件的概要描述，包括主要的输入/输出、主要功能、性能等。2.1.2运行环境规定描述本系统赖于运行的硬件、软件环境2.2总体设计说明2.2.1基本设计概述列出在描述、说明总体设计时要用到的一些基本概念，给出其解释说明。2.2.2设计思想阐述在进行总体设计时的基本考虑。结合设计限制，说明如何根据这些设计限制进行综合考虑后而建立起目标系统的总体结构及功能划分；亦可将所考虑过的多个总体设计作对比分析，说明选择当前总体结构的原因。2.3系统结构和处理流程2.3.1系统结构用框图形式说明目标系统的模块划分，扼要说明每个模块的标识符和功能，分层次地给出各元素之间的控制与被控制关系。3.接口设计3.1外部接口3.1.1用户接口列出系统将向用户提供的操作命令、功能说明和用法描述，系统的响应信息及其含义。3.1.2硬件接口说明本系统的硬件接口的设计安排。3.1.3软件接口说明本系统的软件接口的设计安排。3.1.4通讯接口说明本系统的通讯接口的设计安排。3.2内部接口说明本系统内各功能模块间的接口设计。4.属性设计说明系统对以下三个方面的属性所作的特殊设计和考虑。4.1可靠性4.2安全性4.3可维护性5.系统数据结构5.1逻辑结构设计要点说明系统主要数据的逻辑结构，包括定义、存储要求、一致性约束条件等。5.2数据结构与模块的关系可采用矩阵图形式，并规定以下符号C创建 U更新 R读出使用6.运行设计说明对系统运行时的顺序、控制、时间等的设计安排。7.系统出错处理7.1出错类别对系统对可能出现的某些错误和故障作了专门的设计考虑，并给出这些错误或故障的定义。7.2出错处理说明将使用的恢复或再启动技术，使软件从故障点恢复执行或软件从头开始重新运行的方法。8.开发环境8.1硬件环境列出开发本系统所需要的硬件平台、工具等。8.2软件环境列出开发本系统所需要的软件平台，如操作系统、数据库、网络平台、软件辅助工具及使用周期等。9.系统调试与测试方法9.l调试方法说明系统调试的环境、工具，应观察的结果等。9.2测试方法说明集成测试的方法(从下而上或从上而下)、模块测试的顺序，给出辅助模块、驱动模块及测试用例，说明这些测试用例的选取原则。(3)软件详细设计说明书关键词：摘要：缩略语说明：参考资料：1.引言说明是哪个系统或何种系统的哪个模块的软件详细设计说明书。2.设计思想阐述在进行设计时的基本考虑。结合设计限制，说明如何根据这些设计限制进行综合考虑后而建立起目标系统的结构及功能划分；亦可将所考虑过的多个设计作对比分析，说明选择当前结构的原因。3.软件结构3.1功能需求详细描述其功能，若是模块，应描述它所处的大系统中的位置、与系统的关系及相关模块的关系。3.2子模块划分用图形说明本系统(或模块)的实现，即系统内部的子模块划分。3.3子模块间关系说明各子模块间的控制、顺序等藕合关系。4.公共数据结构给出本系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似C语言的数据说明格式来描述。5.程序15.1输入详细说明本程序的输入参数，包括取值范围、含义，参数间的控制、顺序、独立或依赖等关系。5.2输出详细说明本程序的输出参数，包括取值范围、含义，参数间的控制、顺序、独立或依赖等关系。5.3返回说明返回值的含义6.程序2N.程序m(结构与5相同)(4)通讯协议说明书关键词：摘要：缩略语说明：参考资料：1.引言1.1背景说明本文档所属的软件项目名称。1.2硬件环境用图形方式描述通讯双方的硬件环境构成及通讯物理链路。1.3功能说明简述通讯双方各自的功能，说明通讯目的。2.通讯协议2.1命令格式含发命令格式及收命令格式，说明每一项的数据类型和含义。2.2命令描述说明每一种命令的具体格式、含义及要求的应答格式，该部分内容的编写要依据各自的特点编写。例如可分类描述，若有命令码编写规则要专门描述，描述的原则是清晰、完整、易懂。(5)函数调用协议说明书关键词：摘要：缩略语说明：参考资料：1.引言l.1背景说明本文档属于哪个软件项目。1.2硬件环境用图形方式描述通讯双方的硬件环境构成及通讯物理链路。1.3功能说明简述通讯双方各自的功能，说明通讯的可靠性及速率要求。2.函数调用说明(6)系统对接联调说明书1 引言1.1 编写目的1.2 用途1.3 参与对接联调的人员名单1.4 对接联调起始时间2 用户系统3 本系统设备配置5 对接安装步骤6 发现的问题 7 适应性修改8改进建议(7)软件测试计划关键词：摘要：缩略语说明：参考资料：1.测试计划名称为本测试计划书定义一个专用名称。2.引言归纳所要求测试的软件项和软件特性，可以包括系统目标、背景、范围及引用材料等。在最高层测试计划书中，如果存在下述文件，则需要引用它们：项目计划、质量保证计划、有关的政策、有关的标准等。3.测试项描述被测试的对象，包括其版本、修订级别，并指出在测试开始之前对逻辑或物理变换的要求。4.被测试的特性指明所有要被测试的软件特性及其组合，指明每个特性或特性组合有关的测试设计说明。5.不被测试的特性指出不被测试的所有特性和特性的有意义的组合及其理由。6.方法描述测试的总体方法，规定测试指定特性组所需的主要活动、技术和工具，应详尽地描述方法，以便列出主要的测试任务，并估计执行各项任务所需的时间。规定所希望的最低程度的测试彻底性，指明用于判断测试彻底性的技术(如：检查哪些语句至少执行过一次)。指出对测试的主要限制，例如：测试项可用性、测试资源的可用性和测试截止期限等。7.测试项通过准则各测试项通过测试的标准。8.暂停标准和再启动要求规定用于暂停全部或部分与本计划有关的测试项的测试活动的标准，规定当测试再启动时必须重复的测试活动。9.应提供的测试文件规定测试完成后所应递交的文件，这些文件可以是前述文件的全部或者部分。10.测试任务指明执行测试所需的任务集合，指出任务间的一切依赖关系和所需的一切特殊技能。11.环境要求规定测试环境所必备的和希望有的性质，其中包括硬件、通信和系统软件的物理特征、使用方式以及任何其它支撑测试所需的软件或设备，指出所需的特殊测试工具及其它测试要求，指出测试组目前还不能得到的所有要求的来源。12.职责指出负责管理、设计、准备、执行、监督、检查和仲裁的小组，指出负责提供测试项和提供测试环境的小组。这些小组可包括开发人员、测试人员、操作员和质量保证人员。13.人员和训练要求指明测试人员应有的水平以及为掌握必要技能可供选择的训练科目。14.进度在软件项目进度中规定的测试起点以及所有测试项传递时间。定义所需的新的测试起点，估计完成每项测试任务所需的时间，为每项测试任务规定进度，对每项测试资源规定使用期限。 (8)软件测试报告关键词：摘要：缩略语说明：参考资料1测试任务名称和内容2模块功能概述3测试项目3.1 测试项目一3.1.1 目的3.1.2 测试环境与版本3.1.3 输入3.1.4 预期结果3.1.5 实际结果3.1.6 异常现象及分析3.1.7 环境影响分析3.1.8 测试人员和日期3.1.9 重复执行结果3.2 测试项目二3.N 测试项目N4测试充分性评价5结果分析6测试结论四硬件设计文档编写规范(一)规范文档清单 硬件需求规格说明书 硬件概要设计说明书 单板硬件概要设计说明书 单板硬件详细设计说明书 单板软件详细设计说明书 单板硬件过程调试报告 单板软件过程调试报告 单板硬件测试报告 硬件系统联调报告(二)规范文档内容(1)硬件需求规格说明书硬件需求规格说明书是描写硬件设计目标、基本功能、基本配置、主要性能指标、运行环境、约束条件以及开发经费和进度等要求，它的基本依据是产品需求规格说明书及总体方案书。它是硬件总体设计和制订硬件开发计划的依据。具体编写内容如下：关键词：摘要：缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义参考资料：列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。1.引言2.开发项目的名称和型号3.系统历史及修改说明4.基本配置5.运行环境6.硬件整体系统的基本功能和主要性能指标7.硬件分系统的基本功能和主要性能指标8.功能模块的划分9.关键技术的攻关10.外购硬件的名称、型号、生产单位、主要技术指标11.主要仪器设备12.国内外同类产品的技术介绍13.开发经费14.开发进度及文档计划15.其它 (2)硬件概要设计说明书硬件概要设计说明书是根据需求规格说明书、总体方案书及硬件需求规格说明书的要求进行设计后编制的报告，它是硬件详细设计的依据，具体编写内容如下：关键词：摘要：缩略语说明：参考资料：1.引言2.开发项目的名称和型号3.系统历史及修改说明4.功能及主要性能指标5.系统总体结构图及功能划分6.单板命名7.系统逻辑框图8.组成系统各功能块的逻辑框图、电路结构图及单板组成9.单板逻辑框图和电路结构图10.关键技术讨论11.关键器件12.可靠性、安全性、电磁兼容性讨论13.电源设计14.工艺、结构设计初步15.包装设计15.硬件联调测试方案16.其他(3)单板硬件概要设计说明书关键词：摘要：缩略语说明：参考资料：1.概述2.单板版本号、单板在整机中的位置、开发目的及主要功能3.单板功能描述、单板尺寸(单位)4.单板逻辑框图及各功能模块说明5.单板软件功能描述6.单板软件功能模块划分7.接口简单定义、与相关板的关系8.指标(主要性能指标、功耗、采用标准)9.开发仪表、仪器10.其他(4)单板软件概要设计说明书关键词：摘要：参考资料：1概述1.1背景1.2编程语言、编译器和调试环境2总体设计2.1硬件说明2.2功能2.3存贮区分配2.4数据结构2.5软件功能设计细节与要求2.6相关通讯协议(5)单板硬件详细设计说明书关键词：摘要：缩略语说明：参考资料：1.概述2.单板历史及修改说明3.逻辑框图及各功能模块详细说明、各功能模块实现方式4.地址分配、控制方式、接口方式、存贮器空间、中断方式5.接口管脚信号详细定义、时序说明、性能指标6.指示灯说明7.外接线定义(母板跳线、DIP开关、电源保险)8.可编程器件图、功能模块说明、相关时序图9.原理图设计10.PCB图设计11.详细物料清单12.PCB板工艺、结构设计说明13.单板测试、调试计划(技术)(6)单板软件详细设计说明书关键词：摘要：缩略语说明：参考资料：1.概述(1)背景说明所属项目名称、编号及相应硬件单板版本名称、版本历史修改说明。(2)编程语言、编译器和调试环境2.硬件描述与功能要求2.1硬件说明(1)CPU类型(2)RAM说明(3)R0M说明(4)控制灯和DIP开关功能说明2.2功能(1)单板功能(2)软件功能2.3数据结构(1)存贮区分配(2)逻辑结构(3)物理结构(4)配置数据2.4设计细节2.4.1中断含中断级别与中断处理等内容2.4.2程序流程(或状态迁移)2.4.2.1主程序2.4.2.2子程序2.4.2.N子程序2.4.3其它2.4.3.1故障(1)故障类型(2)故障处理2.4.3.2相关通讯协议说明物理层、链路层通讯协议和高层通讯协议由哪些文档定义3.注意事项(操作说明，设计局限性及潜力)4.其他 (7)单板硬件测试报告关键词：摘要：缩略语说明：参考资料：1. 概述1.1测试目的1.2测试方案2. 单板功能模块划分3. 各功能模块设计输入输出信号及性能参数4. 各功能模块测试点确定5. 各测试参考点实测原始记录及分析6. 板内高速信号线测试原始记录及分析7. 系统I/O口信号线测试原始记录及分析8. 整板性能测试结果分析(8)单板软件测试报告关键词：摘要：缩略语说明：参考资料：1测试目的及方案1.1 测试目的1.2 测试方案1.2.1 测试方案综述1.2.2 测试方案对测试程序的要求1.2.3 测试环境1.2.4 测试结果分析表格2测试项目及步骤2.1 总体步骤2.2 各测试项目及步骤3测试结果4测试分析及建议4.1 测试分析4.2 建议5测试者6测试日期(9)硬件系统联调报告关键词：摘要：缩略语说明：参考资料：1. 系统功能模块划分2. 系统功能模块调试进展3. 系统接口信号的测试原始记录及分析4. 系统联调中出现的问题及解决5. 整机性能评估6. 其他五结构、包装设计文档编写规范(一)规范文档清单 结构概要设计说明书 结构详细设计说明书(二)规范文档内容(1)结构概要设计说明书关键词：摘要：缩略语说明：参考资料：1. 概述2. 外形设计图3. 结构示意图4. 功能及要求5. 电子结构图6. 局部形状示意图7. 与其它设备的联接8. 附件 (2)结构详细设计说明书关键词：摘要：缩略语说明：参考资料：1.概述2.总体设计2.1功能及要求2.2产品外形图2.3电子结构图3.产品架构4.产品组装流程图5.结构物料清单6.工程设计图7.附件(3)包装详细设计说明书关键词：摘要：缩略语说明：参考资料：1概述2产品外形3产品结构示意图4产品配件清单5包装方式5.1包装形式概述5.2内包装材料设计5.3彩盒设计 5.3.1外形尺寸 5.3.2彩页设计5.4卡通箱设计 5.4.1外形尺寸 5.4.2印刷内容设计6包装材料清单7其他六产品移交文档编写规范(一)规范文档清单 生产移交说明书 版本说明及配套表 技术手册 安装手册 用户手册 验收手册 培训手册(二)规范文档内容(1)生产移交说明书关键词：摘要：缩略语说明：参考资料：1. 概述2. 电路原理图3. PCB图4. 元器件清单5. 特殊生产工艺说明 可编程器件生产说明 CPU烧录说明 FLASH烧录及升级说明 其它说明6. 产品维修指导7. 生产测试说明 硬件测试 软件测试8. 成品测试说明 功能测试 性能测试9. 结构外形设计10. 产品外包装设计11. 产品装箱清单12. 其它 (3)版本说明及配套表1.系统/产品版本说明 本系统/产品的一般性描述产品名称、型号、版本号。 对前一个版本不足之处的改进 增加的新功能 原有功能参考文档主要的相关技术文档内容及最近的版本说明书。注：产品或系统的版本号以各个组成模块中最主要、最有意义的模块的版本号为基准加以定义。2.系统版本配套表系统名称系统代码系统型号系统组成序号配套产品名称代码版本号备注1配套产品12配套产品2N配套产品N3.产品版本配套表产品名称产品代码产品型号产品组成序号产品组成名称代码版本号备注1组成12组成2N组成N(3)技术手册该手册主要描述系统/产品的系统结构、硬件构成、软件构成、基本工作原理、功能框图、业务性能、技术指标、机械结构、电源及环境要求等。此文档主要用于市场技术谈判、投标阶段。主要内容如下：1. 概述2. 系统结构容量、配置、业务、指标3. 环境要求4. 硬件结构各子系统描述、基本工作原理、功能框图、单板对外接口5. 软件结构各子系统描述6. 机械结构7. 功能说明8. 性能指标9. 电源(配电、功耗等)10. 其它(4)安装手册该手册主要描述系统/产品的工程安装工程及步骤，它包括以下两个部分： 安装所需要的设备清单及资料 所有必要的安装事项及各事项的安装过程主要的内容如下：1. 环境要求2. 机械安装3. 电气安装4. 硬件安装5. 软件安装6. 整机调试7. 其它说明(5)用户手册用户手册用于用户日常操作和维护，应详细介绍系统/产品的操作和维护方法，它是设备运行的基本资料，包括可能发生的每一项具体操作，操作人员可以通过系统的界面或命令行语言来执行操作，完成具体的操作任务。手册的编写主要由操作部分及维护部分两部分组成，要求易读，以便于用户使用。主要内容如下：1. 系统/产品简述2. 系统/产品操作说明3. 系统/产品维护说明 如何保持系统/产品正常运行 如何查明和判断当前系统/产品的状态l 故障定位l 错误信息l 告警信息l 电路板开关及指示灯说明 如何恢复系统/产品的正常运行状态(6)验收手册在系统/产品安装完成后，应由顾客和安装人员组成的验收小组进行测试，以使顾客确认收到了满足其需求及归档指标的系统/产品，本手册应说明所有验收的项目，应达到的功能指标及测试方法。此手册可用于工程现场验收，如顾客系统的设计验证测试、试运行验收测试、正式验收测试。手册的主要内容如下：1. 验收准备检查2. 设备及硬件安装验收3. 设计验证测试4. 试运行验收测试5. 正式验收测试6. 系统验收标准7. 附录验收项目1方法和要求指标结果结论验收项目N买方代表：年 月 日卖方代表：年 月 日(7)培训手册本手册是在技术手册、用户手册和安装手册的基础上，补充系统/产品必要的基础知识和基本概念，以便于顾客详细和掌握。此手册用于顾客培训，主要内容如下： 基础知识和基本概念 硬件系统 软件系统 安装工艺及结构 操作及维护方法 系统原理 培训计划七方案建议书编写规范1.前言概述公司各项基本情况。2.公司产品系统概述系统设计原则和指导思想，系统结构与组成等。3.顾客应用系统(1) 系统概况(2) 客户系统结构(3) 系统功能及标准接口4.系统主要设备介绍为顾客提供的各项产品，以及它们的结构组成、工作原理、主要功能、性能指标及使用方法等。5.系统主要软件介绍系统主要软件的功能等。6.系统安全特性介绍安全设计思想、实现方法、管理方式、事故处理及预防等。7.系统特点介绍获得的荣誉、先进的技术、鲜明的特点等。8.典型应用介绍同类产品在市场应用的事例等。9.质量、信誉和售后服务能力包括国家相关批准文件。八内部验收文档编写规范(一)规范文档清单 验收测试方案 测试单 验收测试报告(二)规范文档内容(1)验收测试方案关键词：摘要：缩略语说明：参考资料：1.测试计划名称为本测试计划书定义一个专用名称。2.引言归纳内部验收测试的目标、背景、范围及引用材料等。在最高层测试计划书中，如果存在下述文件，则需要引用它们：项目计划、质量保证计划、有关的政策、有关的标准等。3.测试对象描述被测试的对象，包括其版本、修订级别，并指出在测试开始之前对逻辑或物理变换的要求。4.被测试的特性范围指明所有要被测试的软件特性及其组合范围。5.不被测试的特性范围指出不被测试的所有特性范围及其理由。6.方法描述测试的总体方法，规定测试指定特性组所需的主要活动、技术和工具，应详尽地描述方法，以便列出主要的测试任务，并估计执行各项任务所需的时间。规定所希望的最低程度的测试彻底性，指明用于判