10-研发部文档格式与规范

Xxxx公司研究所文档规范公司年月1目录1．引言............................................................................................................22．文档内容规范................................................................................................3《系统可行性研究报告》编写内容规范..................................................................4《产品研制规范》编写内容规范..........................................................................6《软件需求说明书》编写内容规范......................................................................12《硬件总体设计方案》编写内容规范....................................................................16《软件概要设计说明书》编写内容规范（面向过程）...............................................20《软件概要设计说明书》编写规范（面向对象）.....................................................22《系统调试方案》编写内容规范.........................................................................26《单板设计规范》编写内容规范.........................................................................27《软件模块设计方案》编写内容规范....................................................................30《自测方案》编写内容规范...............................................................................31《自测报告》编写内容规范...............................................................................32《单板设计说明》编写内容规范.........................................................................33《软件模块设计说明》编写内容规范....................................................................36《可编程器件设计说明》编写内容规范.................................................................38《单板调试说明》编写内容规范.........................................................................39《软件模块调试说明》编写内容规范....................................................................40《系统调试说明》编写内容规范.........................................................................41《系统测试方案》编写内容规范.........................................................................42《可靠性试验方案》编写内容规范......................................................................43《系统测试规程》编写内容规范.........................................................................48《系统测试报告》编写内容规范.........................................................................49《可靠性报告》编写内容规范............................................................................52《项目开发总结报告》编写内容规范....................................................................543．文档编写格式要求.........................................................................................544．附录...........................................................................................................57附录1：软件设计IPO图..................................................................................57附录2：技术文件的封面样式.............................................................................6021．引言为了控制文档质量，参照公司有关企业标准，对产品各阶段有关文档规范进行了完善和补充。各文档所对应的开发阶段如下表所示。项目各阶段文档清单阶段文档种类/名称项目论证1.项目可行性研究任务书2.项目可行性研究报告3.可行性研究评审报告4.立项申请报告5.研制任务书评审报告系统设计1.产品研制规范2.总体设计方案3.硬件总体设计方案4.软件需求说明书；5.软件概要设计说明书（面向过程、面向对象）；6.数据要求和数据库设计说明书；7.系统测试方案；8.硬件测试方案；9.软件测试方案；10.自测方案11.分系统设计方案；12.软件模块设计方案；13.产品分系统、单元及单板命名；14.单元/单板设计规范；15.系统可靠性设计说明；16.可靠性试验方案；17.整机工艺、结构设计方案；18.项目开发手册。工程研制1.软件模块设计，包括2.软件模块详细设计说明（包括程序流程图或SDL图）；3.软件模块测试说明、测试报告；4.程序代码，编译文件、运行文件及程序配置清单；5.软件模块自测报告；6.电源的技术文件，包括——电源设计说明；——电源原理图、PCB图、材料清单；——电源调试说明——电源测试说明；——电源测试报告；7.其它技术文件，包括——母板（背板）设计说明、原理图、PCB图、材料清单；——系统内、外连接线的说明；——外购件、外协件技术要求；（接续页）3工程研制8.单元/单板的技术文件，包括——单元/单板设计说明；——单元/单板软件设计说明；——可编程器件（或DSP）设计说明；——单元/单板调试说明；——单元/单板测试规程；——原理图和PCB图、材料清单；——单板软件程序代码、编译文件、运行文件、程序配置、单板软件清单；——测试报告；9.结构设计文件，包括——单元结构设计说明；——装配图和零件图、装配材料清单；——整件明细表；——专用件、标准件、外购件、通（借）用件汇总表；10.工艺设计文件，包括——单板及部件的工艺设计；——线缆及布线工艺设计；——线缆清单；11.包装设计文件，包括——包装设计说明；——包装工艺说明；——包装结构图；——包装材料清单；12.自测报告——单板自测报告；——模块自测报告；——系统自测报告13.系统调试文件，包括——系统调试说明；——系统调试报告；14.系统测试文件，包括——系统测试说明；——系统测试规程；——软件测试规程；——系统测试报告；15.集成测试文件，包括——集成测试规程；——集成测试报告；16.可靠性报告；17.系统配置说明；18.工程说明和用户资料，包括——用户手册（包括技术手册、安装手册、操作维护手册）；——工程规范；19.样机评审报告；20.转产任务书。21.项目开发总结报告注：文档规范可随时提出修改意见，经研究所批准后执行2．文档内容规范（接上页）4《系统可行性研究报告》编写内容规范《系统可行性研究报告》是在产品调研阶段里，由研究所组织，系统设计部负责、产品设计部门和市场体系各部门配合协助，对产品的市场需求、技术发展、技术生产能力、经济效益、市场定位、整机功能特性等进行可行性研究的报告。《可行性研究报告》作为产品立项开发的主要依据，具体编写内容如下。1．前言描述产品相关的基本情况。2．适用范围（市场定位）给出产品的用户范围。3．市场情况分析根据国家建设和社会需要，通过对市场和用户的调查研究，科学地预测国内外产品的发展状况和发展趋势，给出预期的市场容量及我们可以达到的市场占有率，并预测产品的生命周期。4．现有产品及相关厂家情况应详细说明相关厂家产品的技术特点，性能指标（包括可信性指标），优缺点、成本、价格、服务及竞争力情况。5．技术能力及生产能力分析指出公司开发此产品的相关技术和人才积累情况，开发和生产难度，现有生产线所需改造的投入和生产能力分析。6、产品开发目标及特征产品开发目标包括产品功能、性能和可信性要求，产品设计所应遵循的主要国际、国内和行业标准，产品鉴定的权威机构。7、确定零版本特性确定提供给用户使用的零版本（或开局版本）特性，主要包括产品软硬件功能、性能和可信性要求。8、研制周期初步分析初步估计产品研制各阶段时间要求。9、资源要求初步分析初步分析产品研制各阶段人力、财力（资金）、物力（开发工具、工作场地）等资源要求。10、产品成本与价格初步估计5产品成本需综合考虑开发成本、元材料成本、生产成本、销售成本和维护成本。产品价格包括目前市场平均价格、市场价格走势、主要竞争对手的成本与价格、用户的期望价格（可接受价格）等。11、产品经济效益初步分析根据对产品市场、技术、生产能力、成本、价格等因素的分析，在财务部门的协助下，估计投资此项产品开发所能获得的经济效益，包括产品的毛利润率、净利润率、净资产回报率、收回投资的时间等。12、投资风险及建议给出投资此项产品开发的风险，包括市场风险、技术风险及其他可能的风险及对策，对是否投资此项产品开发作出建议。6《产品研制规范》编写内容规范《产品研制规范》作为市场与开发的接口文档，主要从高层次来描述系统所要解决的问题，描述用户需要怎样的产品或服务，并对实现需求目标所需采取的措施和计划进行描述。可作为软硬件总体设计的依据，具体编写内容如下。1.范围本规范规定了XX（产品型号）XX（产品名称）的功能需求、可信性需求、可生产性需求以及设计与开发验证方案、设计与开发确认方案、进度、成本估计等方面的要求可按产品特点增删。本规范适用于XX(产品型号)XX(产品名称)的开发研制工作。2.引用标准按引用标准要求，逐条列出在本规范中引用的所有标准的代号和名称。3.定义和缩略语逐条列出本规范中所涉及定义的名称和含义。本标准应用了以下缩略语：逐项列出本规范中所涉及的